org.kaazing.gateway.service

Interface ServiceProperties

public interface ServiceProperties

Represents a set of regular (String) properties and/or nested properties. Nested properties are ones which are grouped under one or more instances of an owning parent element, whose local name is the name of the nested property. Example:

   <service>
     ...
     <properties>
       <regularProperty>a string value</regularProperty>
       <nestedProperty>
         <name>arrivals</name>
         <property1>value1</property1>
         <property2>value1</property2>
       </nestedProperty>
       <nestedProperty>
         <name>departures</name>
         <property1>value1</property1>
         <property2>value1</property2>
       </nestedProperty>
     </properties>
 </service>
 

In this case, getNested("nestedProperty") returns a list containing two ServiceProperties objects, representing the two sets of properties contained inside parent elements with that name.

Method Summary

Modifier and Type	Method and Description
String	get(String name)
List<ServiceProperties>	getNested(String name) Returns a nested property value (list of property sets).
List<ServiceProperties>	getNested(String name, boolean create) Returns a nested property value, optionally adding the property if it is not yet present.
boolean	isEmpty()
Iterable<String>	nestedPropertyNames()
void	put(String name, String value)
Iterable<String>	simplePropertyNames()

Method Detail

get

String get(String name)

getNested

List<ServiceProperties> getNested(String name)

Returns a nested property value (list of property sets). This list may not be mutable. Use #get(String, boolean) to add or alter nested properties.

Parameters:

name -

Returns:

The nested property value, or an empty list if there is no such property

getNested

List<ServiceProperties> getNested(String name,
                                  boolean create)

Returns a nested property value, optionally adding the property if it is not yet present.

Parameters:

name -

create - If true, the nested property is created if not already present, and the list returned is always mutable, to allow the addition or removal of property sets

Returns:

The nested property value, or an empty list if there is no such property

simplePropertyNames

Iterable<String> simplePropertyNames()

Returns:

Names of the the simple (String) properties

nestedPropertyNames

Iterable<String> nestedPropertyNames()

Returns:

Names of the nested properties

isEmpty

boolean isEmpty()

put

void put(String name,
         String value)