Index
All Classes and Interfaces|All Packages|Serialized Form
A
- add(String, Object) - Method in class org.klojang.path.util.MapBuilder
-
Appends the specified element to the
Collectionfound at the specified path. - AnyBeanReader - Class in org.klojang.invoke
-
A dynamic bean reader class for arbitrary types of beans.
- AnyBeanReader() - Constructor for class org.klojang.invoke.AnyBeanReader
-
Creates a new
AnyBeanReader. - AnyBeanReader(boolean) - Constructor for class org.klojang.invoke.AnyBeanReader
-
Creates a new
AnyBeanReader. - append(String) - Method in class org.klojang.path.Path
-
Returns a new
Pathrepresenting the concatenation of thisPathand the specifiedPath. - append(Path) - Method in class org.klojang.path.Path
-
Returns a new
Pathconsisting of the segments of thisPathplus the segments of the specifiedPath.
B
- BeanReader<T> - Class in org.klojang.invoke
-
A dynamic bean reader class.
- BeanReader(Class<T>, boolean, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanReader
-
Creates a
BeanReaderfor the specified properties of the specified class. - BeanReader(Class<T>, String...) - Constructor for class org.klojang.invoke.BeanReader
-
Creates a
BeanReaderfor the specified properties of the specified class. - BeanReader(Class<T>, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanReader
-
Creates a
BeanReaderfor the specified properties of the specified class. - BeanReaderBuilder<T> - Class in org.klojang.invoke
-
A
Builderclass forBeanReaderinstances. - BeanWriter<T> - Class in org.klojang.invoke
-
A dynamic bean writer class.
- BeanWriter(Class<T>, String...) - Constructor for class org.klojang.invoke.BeanWriter
-
Creates a
BeanWriterfor the specified class. - BeanWriter(Class<T>, FallibleBiFunction<Setter, Object, Object, Throwable>, String...) - Constructor for class org.klojang.invoke.BeanWriter
-
Creates a
BeanWriterfor the specified class. - BeanWriter(Class<T>, FallibleBiFunction<Setter, Object, Object, Throwable>, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanWriter
-
Creates a
BeanWriterfor the specified class. - BeanWriter(Class<T>, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanWriter
-
Creates a
BeanWriterfor the specified class. - begin() - Static method in class org.klojang.path.util.MapBuilder
-
Creates a new
MapBuilder. - begin(Map<String, Object>) - Static method in class org.klojang.path.util.MapBuilder
-
Creates a
MapBuilderthat starts out with the entries in the specified map. - build() - Method in class org.klojang.invoke.BeanReaderBuilder
-
Returns a new
BeanReaderfor instances of typeT.
C
- canRead(String) - Method in class org.klojang.invoke.BeanReader
-
Returns
trueif the specified string represents a property that can be read by thisBeanReader. - canWrite(String) - Method in class org.klojang.invoke.BeanWriter
-
Returns
trueif the specified string represents a property that can be written by thisBeanWriter. - compareTo(Path) - Method in class org.klojang.path.Path
- copy(Map<String, ?>, T) - Method in class org.klojang.invoke.BeanWriter
-
Overwrites all properties in the specified bean with the corresponding values in the specified map.
- copy(T, T) - Method in class org.klojang.invoke.BeanWriter
-
Overwrites all properties in the second bean with the values they have in the first bean.
- copyNonNull(Map<String, ?>, T) - Method in class org.klojang.invoke.BeanWriter
-
Copies all non-null values from the specified map to the specified bean.
- copyNonNull(T, T) - Method in class org.klojang.invoke.BeanWriter
-
Copies all non-null properties from the first bean to the second bean.
- copyOf(Path) - Static method in class org.klojang.path.Path
-
Returns a copy of the specified path.
- createMap() - Method in class org.klojang.path.util.MapBuilder
-
Returns the
Mapresulting from the write actions.
D
- deserialize(Path, int) - Method in interface org.klojang.path.KeyDeserializer
-
Converts the path segment at the specified index to a map key.
E
- empty() - Static method in class org.klojang.path.Path
-
Returns an empty
Pathinstance, consisting of zero path segments. - EMPTY_SEGMENT - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerencountered anull segmentor an empty segment while not processing aMap. - enrich(Map<String, ?>, T) - Method in class org.klojang.invoke.BeanWriter
-
Overwrites all properties in the specified bean whose value is
nullwith the corresponding values in the specified map. - enrich(T, T) - Method in class org.klojang.invoke.BeanWriter
-
Overwrites all properties in the second bean whose value is
nullwith the values they have in the first bean. - equals(Object) - Method in class org.klojang.path.Path
- ErrorCode - Enum Class in org.klojang.path
-
Symbolic constants for read/write failures.
- escape(String) - Static method in class org.klojang.path.Path
-
Escapes the provided path segment.
- EXCEPTION - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkertrapped an exception from underlying code. - EXCLUDE - Enum constant in enum class org.klojang.invoke.IncludeExclude
-
Exclude the provided properties from being read/written.
F
- forClass(Class<T>) - Static method in class org.klojang.invoke.BeanReader
-
Returns a
BuilderforBeanReaderinstances. - from(String) - Static method in class org.klojang.path.Path
-
Returns a new
Pathinstance for the specified path string.
G
- get(String) - Method in class org.klojang.path.util.MapBuilder
-
Returns the value of the specified path if set, else
null. - getBeanClass() - Method in class org.klojang.invoke.BeanReader
-
Returns the class of the objects this
BeanReadercan read. - getBeanClass() - Method in class org.klojang.invoke.BeanWriter
-
Returns the type of the objects this
BeanWritercan write to. - getBeanClass() - Method in exception class org.klojang.invoke.IllegalAssignmentException
-
Returns the class containing the property.
- getCanonicalPath() - Method in class org.klojang.path.Path
-
Returns a new
Pathcontaining only the segments of thisPaththat are not array indices. - getErrorCode() - Method in exception class org.klojang.path.PathWalkerException
-
Return a symbolic constant for the error encountered by the
PathWalker - getGetters(Class<?>, boolean) - Method in class org.klojang.invoke.GetterFactory
-
Returns the public
gettersfor the specified class. - getIncludedGetters() - Method in class org.klojang.invoke.BeanReader
-
Returns the
gettersused by theBeanReaderto read bean properties. - getIncludedSetters() - Method in class org.klojang.invoke.BeanWriter
-
Returns the
settersused by theBeanWriterto write bean properties. - getParamType() - Method in class org.klojang.invoke.Setter
-
Returns the type of the property.
- getProperty() - Method in class org.klojang.invoke.Getter
-
Returns the name of the property.
- getProperty() - Method in class org.klojang.invoke.Setter
-
Returns the name of the property being set by this
Setter. - getPropertyName() - Method in exception class org.klojang.invoke.IllegalAssignmentException
-
Returns the name of the property.
- getPropertyType() - Method in exception class org.klojang.invoke.IllegalAssignmentException
-
Returns the class of the property.
- getReadableProperties() - Method in class org.klojang.invoke.BeanReader
-
Returns the properties that this
BeanReaderwill read. - getReturnType() - Method in class org.klojang.invoke.Getter
-
Returns the type of the property.
- getSetters(Class<?>) - Method in class org.klojang.invoke.SetterFactory
-
Returns the public
settersfor the specified class. - Getter - Class in org.klojang.invoke
-
Represents a getter for a single property.
- GetterFactory - Class in org.klojang.invoke
-
Provides and caches
gettersfor classes. - getValue() - Method in exception class org.klojang.invoke.IllegalAssignmentException
-
Returns the value that was attempted to be assigned to the property
- getWritableProperties() - Method in class org.klojang.invoke.BeanWriter
-
Returns the properties that this
BeanWriterwill write.
H
- hashCode() - Method in class org.klojang.path.Path
I
- illegalAssignment(Object) - Method in class org.klojang.invoke.Setter
-
Generates an
IllegalAssignmentExceptionindicating that the specified value cannot be assigned to the property encapsulated by thisSetter. - IllegalAssignmentException - Exception Class in org.klojang.invoke
-
Thrown by a
BeanWriterif it failed to write a value to a property, for example because of a type mismatch. - in(String) - Method in class org.klojang.path.util.MapBuilder
-
Returns a
MapBuilderfor the map at the specified path. - INCLUDE - Enum constant in enum class org.klojang.invoke.IncludeExclude
-
Only allow the provided properties to be read/written
- IncludeExclude - Enum Class in org.klojang.invoke
-
Used to indicate whether you want to allow or disallow properties from being read by a
BeanReaderor written by aBeanWriter. - INDEX_EXPECTED - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerhad arrived on a list or array, so expected the next segment in thePathto be an array index, but found something other than an integer. - INDEX_NOT_ALLOWED - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerencountered an array index in thePath, but the value of the preceding path segment was something other than a list or array. - INDEX_OUT_OF_BOUNDS - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerencountered an array index in thePaththat was out of bounds for the list or array it was processing. - INSTANCE - Static variable in class org.klojang.invoke.GetterFactory
-
The one and only instance of
GetterFactory. - INSTANCE - Static variable in class org.klojang.invoke.SetterFactory
-
The one and only instance of
SetterFactory. - isEmpty() - Method in class org.klojang.path.Path
-
Returns
trueif this is an emptyPath, consisting of zero segments. - isSet(String) - Method in class org.klojang.path.util.MapBuilder
-
Returns whether the specified path is set to a terminal value (and hence cannot be extended).
- iterator() - Method in class org.klojang.path.Path
-
Returns an
Iteratorover the path segments.
J
- jump(String) - Method in class org.klojang.path.util.MapBuilder
-
Jumps to another branch in the tree of nested maps.
K
- KEY_DESERIALIZATION_FAILED - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that a
KeyDeserializerfailed to deserialize a path segment into a map key. - KeyDeserializationException - Exception Class in org.klojang.path
-
Thrown by a
KeyDeserializerif it fails to deserialize a path segment into a map key. - KeyDeserializationException() - Constructor for exception class org.klojang.path.KeyDeserializationException
-
Instantiates a new
KeyDeserializationException. - KeyDeserializationException(String) - Constructor for exception class org.klojang.path.KeyDeserializationException
-
Instantiates a new
KeyDeserializationException. - KeyDeserializer - Interface in org.klojang.path
-
Defines a mechanism for converting a path segment to a map key.
M
- MapBuilder - Class in org.klojang.path.util
-
An elaborate builder class for Map<String, Object> pseudo-objects.
- MapBuilder() - Constructor for class org.klojang.path.util.MapBuilder
-
Creates a new
MapBuilder. - MapBuilder(Map<String, Object>) - Constructor for class org.klojang.path.util.MapBuilder
-
Creates a
MapBuilderthat starts out with the entries in the specified map. - MapBuilder.PathBlockedException - Exception Class in org.klojang.path.util
-
Thrown when trying to write to a path that has already been set, or that extends beyond a path segment with a terminal value (anything other than a map).
N
- NO_SUCH_KEY - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerencountered a segment that did not correspond to any key of theMapit was processing. - NO_SUCH_PROPERTY - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerencountered a segment that did not correspond to any (accessible) property of the JavaBean it was processing. - NoPublicGettersException - Exception Class in org.klojang.invoke
-
Thrown if a
BeanReaderis created for a class with zero public getters, or if they were all excluded while constructing theBeanReader. - NoPublicSettersException - Exception Class in org.klojang.invoke
-
Thrown if a
BeanWriteris created for a class with zero public setters, or if they were all excluded while constructing theBeanWriter. - noSuchProperty(Object, String) - Static method in exception class org.klojang.invoke.NoSuchPropertyException
-
Returns a
NoSuchPropertyExceptionfor the specified name. - NoSuchPropertyException - Exception Class in org.klojang.invoke
-
Thrown when attempting to read or write a non-existent or inaccessible bean property.
- NOT_MODIFIABLE - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerattempted to modify aListorMapand theListorMapresponded by throwing anUnsupportedOperationException.
O
- of(String) - Static method in class org.klojang.path.Path
-
Returns a
Pathconsisting of a single segment. - of(String...) - Static method in class org.klojang.path.Path
-
Returns a
Pathconsisting of the specified segments. - of(String, String) - Static method in class org.klojang.path.Path
-
Returns a
Pathconsisting of the specified segments. - of(String, String, String) - Static method in class org.klojang.path.Path
-
Returns a
Pathconsisting of the specified segments. - of(String, String, String, String) - Static method in class org.klojang.path.Path
-
Returns a
Pathconsisting of the specified segments. - of(String, String, String, String, String) - Static method in class org.klojang.path.Path
-
Returns a
Pathconsisting of the specified segments. - ofSegments(String[]) - Static method in class org.klojang.path.Path
-
Returns a
Pathconsisting of the specified segments. - org.klojang.invoke - module org.klojang.invoke
-
A module centered around path-based object access and dynamic invocation.
- org.klojang.invoke - package org.klojang.invoke
-
Provides a bean reader and bean writer based on method handles and a minimal amount of reflection.
- org.klojang.path - package org.klojang.path
-
Classes related to following a path to the object or resource denoted by it.
- org.klojang.path.util - package org.klojang.path.util
-
Utilities related to path-based access and dynamic invocation.
P
- parent() - Method in class org.klojang.path.Path
-
Return the parent of this
Path. - Path - Class in org.klojang.path
-
Specifies a path to a value within an object.
- PathWalker - Class in org.klojang.path
-
A
PathWalkerlets you read and write deeply nested values usingPathobjects. - PathWalker(String...) - Constructor for class org.klojang.path.PathWalker
-
Creates a
PathWalkerfor the specified paths. - PathWalker(List<Path>) - Constructor for class org.klojang.path.PathWalker
-
Creates a
PathWalkerfor the specified paths. - PathWalker(List<Path>, boolean) - Constructor for class org.klojang.path.PathWalker
-
Creates a
PathWalkerfor the specified paths. - PathWalker(List<Path>, boolean, KeyDeserializer) - Constructor for class org.klojang.path.PathWalker
-
Creates a
PathWalkerfor the specified paths. - PathWalker(Path...) - Constructor for class org.klojang.path.PathWalker
-
Creates a
PathWalkerfor the specified paths. - PathWalkerException - Exception Class in org.klojang.path
-
Thrown by a
PathWalkerif a path-read or path-write error occurs. - poll(String) - Method in class org.klojang.path.util.MapBuilder
-
Returns a
Resultobject containing the value of the specified path, orResult.notAvailable()if the path is not set.
R
- read(Object) - Method in class org.klojang.invoke.Getter
-
Reads the value of the property off the specified bean
- read(Object) - Method in class org.klojang.path.PathWalker
-
Reads the value of the first path specified through the constructor.
- read(Object, String) - Method in class org.klojang.invoke.AnyBeanReader
-
Returns the value of the specified property on the specified bean.
- read(T, String) - Method in class org.klojang.invoke.BeanReader
-
Returns the value of the specified property on the specified bean.
- readValues(Object) - Method in class org.klojang.path.PathWalker
-
Returns the values of all paths specified through the constructor.
- readValues(Object, Object[]) - Method in class org.klojang.path.PathWalker
-
Reads the values of all paths specified through the constructor.
- readValues(Object, Map<Path, Object>) - Method in class org.klojang.path.PathWalker
-
Reads the values of all paths and inserts them into the provided path-to-value map.
- replace(int, String) - Method in class org.klojang.path.Path
-
Returns a new
Pathwith the path segment at the specified array index set to the new value. - reset() - Method in class org.klojang.path.util.MapBuilder
-
Takes you back to the root map.
- reverse() - Method in class org.klojang.path.Path
-
Returns a
Pathin which the order of the segments is reversed.
S
- segment(int) - Method in class org.klojang.path.Path
-
Returns the path segment at the specified index.
- set(String, Object) - Method in class org.klojang.path.util.MapBuilder
-
Sets the specified path to the specified value.
- Setter - Class in org.klojang.invoke
-
Represents a setter for a single property.
- SetterFactory - Class in org.klojang.invoke
-
Provides and caches
settersfor classes. - shift() - Method in class org.klojang.path.Path
-
Returns a
Pathwith all segments of thisPathexcept the first segment. - size() - Method in class org.klojang.path.Path
-
Returns the number of segments in this
Path. - stream() - Method in class org.klojang.path.Path
-
Returns a
Streamof path segments. - subPath(int) - Method in class org.klojang.path.Path
-
Returns a new
Pathstarting with the segment at the specified array index. - subPath(int, int) - Method in class org.klojang.path.Path
-
Returns a new
Pathconsisting oflengthsegments starting with segmentoffset.
T
- TERMINAL_VALUE - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
Pathcontinued after having reached a terminal value (likenullor a primitive value) or an opaque value (like aString). - toString() - Method in class org.klojang.path.Path
-
Returns this
Pathas a string, properly escaped. - toString() - Method in class org.klojang.path.util.MapBuilder
-
Returns a string representation of the map created thus far.
- TYPE_MISMATCH - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkercould not write a value because its type was incompatible with the target property or array. - TYPE_NOT_SUPPORTED - Enum constant in enum class org.klojang.path.ErrorCode
-
Indicates that the
PathWalkerencountered a value that it doesn't know how to read or write.
U
- unset(String) - Method in class org.klojang.path.util.MapBuilder
-
Unsets the value of the specified path.
- up(String) - Method in class org.klojang.path.util.MapBuilder
-
Returns a
MapBuilderfor the parent map of the map currently being written.
V
- valueOf(String) - Static method in enum class org.klojang.invoke.IncludeExclude
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.klojang.path.ErrorCode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.klojang.invoke.IncludeExclude
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.klojang.path.ErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- where() - Method in class org.klojang.path.util.MapBuilder
-
Returns the current branch within tree of nested
Mapobjects. - with(Class<?>, String...) - Method in class org.klojang.invoke.BeanReaderBuilder
-
Registers the specified names as properties of the specified type.
- withGetter(Class<?>, String...) - Method in class org.klojang.invoke.BeanReaderBuilder
-
Registers the specified method names as getters with the specified return type.
- withInt(String...) - Method in class org.klojang.invoke.BeanReaderBuilder
-
Registers the specified names as
intproperties on the bean class. - withString(String...) - Method in class org.klojang.invoke.BeanReaderBuilder
-
Registers the specified names as
Stringproperties on the bean class. - write(Object, Object) - Method in class org.klojang.invoke.Setter
-
Sets the property on the specified bean to the specified value.
- write(Object, Object) - Method in class org.klojang.path.PathWalker
-
Sets the value of the first path specified through the constructor.
- write(T, String, Object) - Method in class org.klojang.invoke.BeanWriter
-
Sets the value of the specified property on the specified bean.
- writeValues(Object, Object...) - Method in class org.klojang.path.PathWalker
-
Sets the values of the paths specified through the constructor.
All Classes and Interfaces|All Packages|Serialized Form