i18nplugin

Class PropertiesNode

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

i18nplugin.PropertiesNode

All Implemented Interfaces:

FilterNodeIf, LanguageNodeIf, Serializable, Cloneable, MutableTreeNode, TreeNode

public class PropertiesNode
extends DefaultMutableTreeNode
implements LanguageNodeIf, FilterNodeIf

A Properties-File

Author:

bodum

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Fields inherited from interface i18nplugin.LanguageNodeIf

STATE_MISSING_TRANSLATION, STATE_NON_WELLFORMED, STATE_NON_WELLFORMED_ARG_COUNT, STATE_NON_WELLFORMED_ARG_FORMAT, STATE_NON_WELLFORMED_PUNCTUATION_END, STATE_OK

Constructor Summary

Constructors

Constructor and Description
PropertiesNode(JarFile jarfile, JarEntry entry) Create the Properties-File

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(Locale locale, String key) Checks if a key is available in a locale
TreeNode	getChildAfter(TreeNode child)
TreeNode	getChildAt(int index)
TreeNode	getChildBefore(TreeNode child)
int	getChildCount()
int	getIndex(TreeNode child)
int	getMatchCount() Returns the total number of matches in all sub nodes.
String	getPropertyValue(Locale locale, String key) This method returns a specific value for a key
String	getPropertyValue(String key) This method returns the default value for a key.
void	insert(MutableTreeNode newChild, int childIndex)
boolean	isLeaf()
boolean	matches() Returns true if the node (or any sub node) matches the filter.
void	save() Saves all changes to the User-Directory
void	setFilter(Locale locale, String filter) Sets a new filter.
void	setPropertyValue(Locale locale, String key, String value) Set the Property-Value.
void	storeSorted(Properties prop, OutputStream out, String comments) Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load method.
int	translationStateFor(Locale locale) This method returns the translation state, if all translations are available for a certain locale.

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getDepth, getFirstChild, getFirstLeaf, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertiesNode

public PropertiesNode(JarFile jarfile,
              JarEntry entry)

Create the Properties-File

Parameters:

jarfile - Jar-File that contains the Entry

entry - Property-File

Method Detail

insert

public void insert(MutableTreeNode newChild,
          int childIndex)

Specified by:

insert in interface MutableTreeNode

Overrides:

insert in class DefaultMutableTreeNode

getPropertyValue

public String getPropertyValue(String key)

This method returns the default value for a key.

Parameters:

key - key to get property for

Returns:

the default value of a key

getPropertyValue

public String getPropertyValue(Locale locale,
                      String key)

This method returns a specific value for a key

Parameters:

locale - get value for this locale

key - get value for this key

Returns:

value for specific locale and key

setPropertyValue

public void setPropertyValue(Locale locale,
                    String key,
                    String value)

Set the Property-Value. If the value is null, the key will be removed.

Parameters:

locale -

key -

value -

containsKey

public boolean containsKey(Locale locale,
                  String key)

Checks if a key is available in a locale

Parameters:

locale -

key -

Returns:

true if key is available

translationStateFor

public int translationStateFor(Locale locale)

Description copied from interface: LanguageNodeIf

This method returns the translation state, if all translations are available for a certain locale. The implementation has to go thru all child-nodes.

Specified by:

translationStateFor in interface LanguageNodeIf

Parameters:

locale - Locale

Returns:

combined translation state for all sub nodes

save

public void save()
          throws IOException

Description copied from interface: LanguageNodeIf

Saves all changes to the User-Directory

Specified by:

save in interface LanguageNodeIf

Throws:

IOException - saving went wrong

storeSorted

public void storeSorted(Properties prop,
               OutputStream out,
               String comments)
                 throws IOException

Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load method. The stream is written using the ISO 8859-1 character encoding.

Properties from the defaults table of this Properties table (if any) are not written out by this method.

If the comments argument is not null, then an ASCII # character, the comments string, and a line separator are first written to the output stream. Thus, the comments can serve as an identifying comment.

Next, a comment line is always written, consisting of an ASCII # character, the current date and time (as if produced by the toString method of Date for the current time), and a line separator as generated by the Writer.

Then every entry in this Properties table is written out, one per line. For each entry the key string is written, then an ASCII =, then the associated element string. Each character of the key and element strings is examined to see whether it should be rendered as an escape sequence. The ASCII characters \, tab, form feed, newline, and carriage return are written as \\, \t, \f \n, and \r, respectively. Characters less than \u0020 and characters greater than \u007E are written as \uxxxx for the appropriate hexadecimal value xxxx. For the key, all space characters are written with a preceding \ character. For the element, leading space characters, but not embedded or trailing space characters, are written with a preceding \ character. The key and element characters #, !, =, and : are written with a preceding backslash to ensure that they are properly loaded.

After the entries have been written, the output stream is flushed. The output stream remains open after this method returns.

Parameters:

out - an output stream.

comments - a description of the property list.

Throws:

IOException - if writing this property list to the specified output stream throws an IOException.

ClassCastException - if this Properties object contains any keys or values that are not Strings.

NullPointerException - if out is null.

Since:

1.2

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

Overrides:

isLeaf in class DefaultMutableTreeNode

getMatchCount

public int getMatchCount()

Description copied from interface: FilterNodeIf

Returns the total number of matches in all sub nodes.

Specified by:

getMatchCount in interface FilterNodeIf

Returns:

matches

public boolean matches()

Description copied from interface: FilterNodeIf

Returns true if the node (or any sub node) matches the filter.

Specified by:

matches in interface FilterNodeIf

Returns:

setFilter

public void setFilter(Locale locale,
             String filter)

Description copied from interface: FilterNodeIf

Sets a new filter.

Specified by:

setFilter in interface FilterNodeIf

Parameters:

locale - - the local to check.

filter - - the filter value to check for.

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class DefaultMutableTreeNode

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class DefaultMutableTreeNode

getIndex

public int getIndex(TreeNode child)

Specified by:

getIndex in interface TreeNode

Overrides:

getIndex in class DefaultMutableTreeNode

getChildAfter

public TreeNode getChildAfter(TreeNode child)

Overrides:

getChildAfter in class DefaultMutableTreeNode

getChildBefore

public TreeNode getChildBefore(TreeNode child)

Overrides:

getChildBefore in class DefaultMutableTreeNode