Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.util
Interface JiveProperties

All Superinterfaces:
java.util.Map
All Known Implementing Classes:
DbJiveProperties, XMLJiveProperties

public interface JiveProperties
extends java.util.Map

An extension of the Map interface to add support for getting child property names or a Collection of all property names.


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Method Summary
 java.util.Collection getChildrenNames(java.lang.String parentKey)
          Return all children property names of a parent property as a Collection of String objects.
 java.util.Collection getPropertyNames()
          Returns all property names as a Collection of String values.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

getChildrenNames

java.util.Collection getChildrenNames(java.lang.String parentKey)
Return all children property names of a parent property as a Collection of String objects. For example, given the properties X.Y.A, X.Y.B, and X.Y.C, then the child properties of X.Y are X.Y.A, X.Y.B, and X.Y.C. The method is not recursive; ie, it does not return children of children.

Parameters:
parentKey - the name of the parent property.
Returns:
all child property names for the given parent.

getPropertyNames

java.util.Collection getPropertyNames()
Returns all property names as a Collection of String values.

Returns:
all property names.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.