public class ControllerProperties
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static int |
CLOSE |
static java.lang.String |
defaultName |
static java.util.logging.Logger |
logger |
static int |
OPEN |
Constructor and Description |
---|
ControllerProperties(ControlP5 theControlP5) |
Modifier and Type | Method and Description |
---|---|
ControllerProperties |
addSet(java.lang.String theSet) |
ControllerProperties |
copy(ControllerInterface<?> theController,
java.lang.String... theSet) |
ControllerProperties |
copy(ControllerProperty theProperty,
java.lang.String... theSet)
copies a ControllerProperty from one set to other(s);
|
ControllerProperties |
delete(ControllerProperty theProperty)
deletes a ControllerProperty from all Sets including the default set.
|
java.util.Map<ControllerProperty,java.util.HashSet<java.lang.String>> |
get() |
java.util.List<ControllerProperty> |
get(ControllerInterface<?> theController) |
ControllerProperty |
getProperty(ControllerInterface<?> theController,
java.lang.String theProperty) |
ControllerProperty |
getProperty(ControllerInterface<?> theController,
java.lang.String theSetter,
java.lang.String theGetter) |
java.util.HashSet<ControllerProperty> |
getPropertySet(ControllerInterface<?> theController) |
ControllerProperties |
getSnapshot(java.lang.String theKey)
restores properties previously stored as snapshot in memory.
|
java.util.ArrayList<java.lang.String> |
getSnapshotIndices()
properties stored in memory can be accessed by index, getSnapshotIndices() returns the index of the snapshot
list.
|
boolean |
load()
load properties from the default properties file 'controlP5.properties'
|
boolean |
load(java.lang.String thePropertiesPath) |
ControllerProperties |
move(ControllerInterface<?> theController,
java.lang.String fromSet,
java.lang.String toSet) |
ControllerProperties |
move(ControllerProperty theProperty,
java.lang.String fromSet,
java.lang.String toSet)
Moves a ControllerProperty from one set to another.
|
ControllerProperties |
only(ControllerProperty theProperty,
java.lang.String theSet)
stores a ControllerProperty in one particular set only.
|
ControllerProperties |
print() |
ControllerProperties |
register(ControllerInterface<?> theController,
java.lang.String theProperty)
registering a property with only one parameter assumes that there is a setter and getter function present for the
Controller.
|
ControllerProperty |
register(ControllerInterface<?> theController,
java.lang.String thePropertySetter,
java.lang.String thePropertyGetter)
adds a property based on names of setter and getter methods of a controller.
|
ControllerProperties |
remove(ControllerInterface<?> theController) |
ControllerProperties |
remove(ControllerInterface<?> theController,
java.lang.String... theSet) |
ControllerProperties |
remove(ControllerInterface<?> theController,
java.lang.String theProperty) |
ControllerProperties |
remove(ControllerInterface<?> theController,
java.lang.String theSetter,
java.lang.String theGetter) |
ControllerProperties |
remove(ControllerProperty theProperty,
java.lang.String... theSet)
removes a ControllerProperty from one or multiple sets.
|
ControllerProperties |
removeSnapshot(java.lang.String theKey)
removes a snapshot by key.
|
boolean |
save()
saves all registered properties into the default 'controlP5.properties' file into your sketch folder.
|
boolean |
saveAs(java.lang.String thePropertiesPath)
saves all registered properties into a file specified by parameter thePropertiesPath.
|
boolean |
saveAs(java.lang.String thePropertiesPath,
java.lang.String... theSets)
saves a list of properties sets into a file specified by parameter thePropertiesPath.
|
ControllerProperties |
saveSnapshot(java.lang.String theKey)
saves a snapshot into your sketch's sketch folder.
|
ControllerProperties |
saveSnapshotAs(java.lang.String thePropertiesPath,
java.lang.String theKey)
saves a snapshot to the file with path given by the first parameter (thePropertiesPath).
|
void |
setFormat(controlP5.ControllerProperties.PropertiesStorageFormat theFormat)
use ControllerProperties.SERIALIZED, ControllerProperties.XML or ControllerProperties.JSON as parameter.
|
void |
setFormat(java.lang.String theFormat) |
ControllerProperties |
setSnapshot(java.lang.String theKey)
logs all registered properties in memory.
|
java.lang.String |
toString() |
ControllerProperties |
updateSnapshot(java.lang.String theKey)
convenience method, setSnapshot(String) also works here since it will override existing log with the same key.
|
public static final int CLOSE
public static java.lang.String defaultName
public static final java.util.logging.Logger logger
public static final int OPEN
public ControllerProperties(ControlP5 theControlP5)
public ControllerProperties addSet(java.lang.String theSet)
public ControllerProperties copy(ControllerInterface<?> theController, java.lang.String... theSet)
public ControllerProperties copy(ControllerProperty theProperty, java.lang.String... theSet)
public ControllerProperties delete(ControllerProperty theProperty)
public java.util.Map<ControllerProperty,java.util.HashSet<java.lang.String>> get()
public java.util.List<ControllerProperty> get(ControllerInterface<?> theController)
public ControllerProperty getProperty(ControllerInterface<?> theController, java.lang.String theProperty)
public ControllerProperty getProperty(ControllerInterface<?> theController, java.lang.String theSetter, java.lang.String theGetter)
public java.util.HashSet<ControllerProperty> getPropertySet(ControllerInterface<?> theController)
public ControllerProperties getSnapshot(java.lang.String theKey)
setSnapshot(String)
public java.util.ArrayList<java.lang.String> getSnapshotIndices()
public boolean load()
public boolean load(java.lang.String thePropertiesPath)
public ControllerProperties move(ControllerInterface<?> theController, java.lang.String fromSet, java.lang.String toSet)
public ControllerProperties move(ControllerProperty theProperty, java.lang.String fromSet, java.lang.String toSet)
public ControllerProperties only(ControllerProperty theProperty, java.lang.String theSet)
public ControllerProperties print()
public ControllerProperties register(ControllerInterface<?> theController, java.lang.String theProperty)
theProperty
- public ControllerProperty register(ControllerInterface<?> theController, java.lang.String thePropertySetter, java.lang.String thePropertyGetter)
thePropertySetter
- thePropertyGetter
- public ControllerProperties remove(ControllerInterface<?> theController)
public ControllerProperties remove(ControllerInterface<?> theController, java.lang.String... theSet)
public ControllerProperties remove(ControllerInterface<?> theController, java.lang.String theProperty)
public ControllerProperties remove(ControllerInterface<?> theController, java.lang.String theSetter, java.lang.String theGetter)
public ControllerProperties remove(ControllerProperty theProperty, java.lang.String... theSet)
public ControllerProperties removeSnapshot(java.lang.String theKey)
public boolean save()
public boolean saveAs(java.lang.String thePropertiesPath)
public boolean saveAs(java.lang.String thePropertiesPath, java.lang.String... theSets)
public ControllerProperties saveSnapshot(java.lang.String theKey)
public ControllerProperties saveSnapshotAs(java.lang.String thePropertiesPath, java.lang.String theKey)
public void setFormat(controlP5.ControllerProperties.PropertiesStorageFormat theFormat)
public void setFormat(java.lang.String theFormat)
public ControllerProperties setSnapshot(java.lang.String theKey)
theKey
- getSnapshot(String)
public java.lang.String toString()
toString
in class java.lang.Object
public ControllerProperties updateSnapshot(java.lang.String theKey)
processing library controlP5 by Andreas Schlegel. (c) 2006-2015