Clearspace API (2.5.22) Core Javadocs

com.jivesoftware.community
Interface JiveProperties<K,V>

All Superinterfaces:
Map<K,V>

public interface JiveProperties<K,V>
extends Map<K,V>

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
Map.Entry<K,V>
 
Method Summary
 boolean getBooleanProperty(K propertyKey)
           
 boolean getBooleanProperty(K propertyKey, boolean defaultValue)
           
 Collection<V> getChildrenNames(K parentKey)
          Return all children property names of a parent property as a Collection of String objects.
 int getIntProperty(K property, int defaultValue)
           
 Collection<V> 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

Collection<V> getChildrenNames(K 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

Collection<V> getPropertyNames()
Returns all property names as a Collection of String values.

Returns:
all property names.

getBooleanProperty

boolean getBooleanProperty(K propertyKey)

getBooleanProperty

boolean getBooleanProperty(K propertyKey,
                           boolean defaultValue)

getIntProperty

int getIntProperty(K property,
                   int defaultValue)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.