org.jahia.services.modulemanager.util

Interface PropertiesValues

public interface PropertiesValues

Structured object used to manipulate properties. Allows to create list and sub-structures

Method Summary

Modifier and Type	Method and Description
byte[]	getBinaryProperty(String name) Gets a property as a byte array
Boolean	getBooleanProperty(String name) Gets a property as a boolean
Integer	getIntegerProperty(String name) Gets a property as an integer
Set<String>	getKeys() Get the list of all keys at this level
PropertiesList	getList(String name) Gets a list structure for the specified name It will create properties list xxx.name[0],xxx.name[1],...
String	getProperty(String name) Gets a property as a string
PropertiesValues	getValues(String name) Gets a sub-structure for the specified name It will create properties list xxx.name.prop1,xxx.name.prop2,...
void	remove(String name) Remove the property, lists and sub-structure with the specified name
String	removeProperty(String name) Removes and return a single property
void	setBinaryProperty(String name, byte[] data) Sets a byte array property
void	setBooleanProperty(String name, boolean value) Sets a boolean property
void	setIntegerProperty(String name, int value) Sets an integer property
void	setProperty(String name, String value) Sets a string property
org.json.JSONObject	toJSON() Convert to JSON object
void	updateFromJSON(org.json.JSONObject array) Import from JSON array

Method Detail

getKeys

Set<String> getKeys()

Get the list of all keys at this level

Returns:

list of keys

getProperty

String getProperty(String name)

Gets a property as a string

Parameters:

name - property name

Returns:

value

getBooleanProperty

Boolean getBooleanProperty(String name)

Gets a property as a boolean

Parameters:

name - property name

Returns:

value

getIntegerProperty

Integer getIntegerProperty(String name)

Gets a property as an integer

Parameters:

name - property name

Returns:

value

getBinaryProperty

byte[] getBinaryProperty(String name)

Gets a property as a byte array

Parameters:

name - property name

Returns:

value

setProperty

void setProperty(String name,
                 String value)

Sets a string property

Parameters:

name - property name

value - the value

setBooleanProperty

void setBooleanProperty(String name,
                        boolean value)

Sets a boolean property

Parameters:

name - property name

value - the value

setIntegerProperty

void setIntegerProperty(String name,
                        int value)

Sets an integer property

Parameters:

name - property name

value - the value

setBinaryProperty

void setBinaryProperty(String name,
                       byte[] data)

Sets a byte array property

Parameters:

name - property name

data - the value

removeProperty

String removeProperty(String name)

Removes and return a single property

Parameters:

name - property name

Returns:

value

getList

PropertiesList getList(String name)

Gets a list structure for the specified name It will create properties list xxx.name[0],xxx.name[1],...

Parameters:

name - property name

Returns:

value

getValues

PropertiesValues getValues(String name)

Gets a sub-structure for the specified name It will create properties list xxx.name.prop1,xxx.name.prop2,...

Parameters:

name - property name

Returns:

value

remove

void remove(String name)

Remove the property, lists and sub-structure with the specified name

Parameters:

name - property name

toJSON

org.json.JSONObject toJSON()
                    throws org.json.JSONException

Convert to JSON object

Returns:

json

Throws:

org.json.JSONException - parsing exception

updateFromJSON

void updateFromJSON(org.json.JSONObject array)
             throws org.json.JSONException

Import from JSON array

Parameters:

array - json value

Throws:

org.json.JSONException - parsing exception