Arch4J 1.1

org.arch4j.propertytree
Interface ReadOnlyProperty

All Known Implementing Classes:
Property

public interface ReadOnlyProperty


Method Summary
 String[] getChildNames()
          return an array of all of this property's children's names.
 String getChildValue(String aName)
           
 String getChildValue(String aName, String defaultValue)
           
 int getChildValueAsInt(String aName)
           
 int getChildValueAsInt(String aName, int defaultValue)
           
 String[] getChildValues(String aName)
           
 String getName()
           
 ReadOnlyProperty getReadOnlyChild(String aName)
           
 ReadOnlyProperty getReadOnlyChild(String aName, String aValue)
          this method searches for a child property with the specified name and value and returns the first match it finds.
 ReadOnlyProperty[] getReadOnlyChildren()
          return an array of all of this property's children as read-only interface.
 ReadOnlyProperty[] getReadOnlyChildren(String aName)
           
 String getValue()
           
 

Method Detail

getName

public String getName()
Returns:
name (key) for this property.

getValue

public String getValue()
Returns:
the value of this property as a String

getChildValues

public String[] getChildValues(String aName)
Returns:
the values of all children with the given name as a String

getChildValue

public String getChildValue(String aName)
Returns:
the values of the first child found with the given name as a String, null if none found

getChildValue

public String getChildValue(String aName,
                            String defaultValue)
Returns:
the values of the first child found with the given name as a String, or the default value id no matching property is found.

getChildValueAsInt

public int getChildValueAsInt(String aName)
                       throws FormatException
Returns:
the values of the first child found with the given name as an integer.
Throws:
RecordReadException - if no child is found
FormatException

getChildValueAsInt

public int getChildValueAsInt(String aName,
                              int defaultValue)
Returns:
the values of the first child found with the given name as an integer, or the default value id no matching property is found.

getReadOnlyChild

public ReadOnlyProperty getReadOnlyChild(String aName,
                                         String aValue)
this method searches for a child property with the specified name and value and returns the first match it finds.

Parameters:
aName - name, or tag for the desired property
aValue - value of the desired property

getChildNames

public String[] getChildNames()
return an array of all of this property's children's names.

Returns:
array of child property names. Returns empty list (not null) if there are no children.

getReadOnlyChildren

public ReadOnlyProperty[] getReadOnlyChildren(String aName)
Parameters:
aName - name (key) of child property to retrieve.
Returns:
array of read-only versions of the child properties with a given name.

getReadOnlyChild

public ReadOnlyProperty getReadOnlyChild(String aName)
Parameters:
aName - name (key) of child property to retrieve.
Returns:
the first read-only version of the child properties with a given name.

getReadOnlyChildren

public ReadOnlyProperty[] getReadOnlyChildren()
return an array of all of this property's children as read-only interface.

Returns:
list of child Properties. Returns empty list (not null) if there are no children.

Arch4J 1.1

Copyright © 2000-2004 SpiderLogic, a service of Wipfli Ullrich Bertelson LLP.