Index (Klojang Invoke)

A B C D E F G H I J K M N O P R S T U V W
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 Collection found 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 Path representing the concatenation of this Path and the specified Path.
append(Path) - Method in class org.klojang.path.Path: Returns a new Path consisting of the segments of this Path plus the segments of the specified Path.

B

BeanReader<T> - Class in org.klojang.invoke: A dynamic bean reader class.
BeanReader(Class<T>, boolean, BeanValueTransformer<T>, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanReader: Creates a BeanReader for the specified properties of the specified class.
BeanReader(Class<T>, boolean, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanReader: Creates a BeanReader for the specified properties of the specified class.
BeanReader(Class<T>, String...) - Constructor for class org.klojang.invoke.BeanReader: Creates a BeanReader for the specified properties of the specified class.
BeanReader(Class<T>, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanReader: Creates a BeanReader for the specified properties of the specified class.
BeanReaderBuilder<T> - Class in org.klojang.invoke: A Builder class for BeanReader instances.
BeanValueTransformer<T> - Interface in org.klojang.invoke: A function that can be applied to transform a value just retrieved from a bean, or about to be set on a bean.
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 BeanWriter for the specified class.
BeanWriter(Class<T>, BeanValueTransformer<T>, String...) - Constructor for class org.klojang.invoke.BeanWriter: Creates a BeanWriter for the specified class.
BeanWriter(Class<T>, BeanValueTransformer<T>, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanWriter: Creates a BeanWriter for the specified class.
BeanWriter(Class<T>, IncludeExclude, String...) - Constructor for class org.klojang.invoke.BeanWriter: Creates a BeanWriter for 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 MapBuilder that starts out with the entries in the specified map.
build() - Method in class org.klojang.invoke.BeanReaderBuilder: Returns a new BeanReader for instances of type T.

C

canRead(String) - Method in class org.klojang.invoke.BeanReader: Returns true if the specified string represents a property that can be read by this BeanReader.
canWrite(String) - Method in class org.klojang.invoke.BeanWriter: Returns true if the specified string represents a property that can be written by this BeanWriter.
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 Map resulting 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 Path instance, consisting of zero path segments.
EMPTY_SEGMENT - Enum constant in enum class org.klojang.path.ErrorCode: Indicates that the PathWalker encountered a null segment or an empty segment while not processing a Map.
enrich(Map<String, ?>, T) - Method in class org.klojang.invoke.BeanWriter: Overwrites all properties in the specified bean whose value is null with 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 null with 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 specified path segment.
Escaping - Search tag in class org.klojang.path.Path: Section
EXCEPTION - Enum constant in enum class org.klojang.path.ErrorCode: Indicates that the PathWalker trapped 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 Builder for BeanReader instances.
from(String) - Static method in class org.klojang.path.Path: Returns a new Path instance for the specified path string.
from(String[]) - Static method in class org.klojang.path.Path: Returns a Path consisting of the specified segments.

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 BeanReader can read.
getBeanClass() - Method in class org.klojang.invoke.BeanWriter: Returns the type of the objects this BeanWriter can 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 Path containing only the segments of this Path that 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 getters for the specified class.
getIncludedGetters() - Method in class org.klojang.invoke.BeanReader: Returns the getters used by the BeanReader to read bean properties.
getIncludedSetters() - Method in class org.klojang.invoke.BeanWriter: Returns the setters used by the BeanWriter to 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 BeanReader will 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 setters for the specified class.
Getter - Class in org.klojang.invoke: Represents a getter for a single property.
GetterFactory - Class in org.klojang.invoke: Assembles, caches, and supplies getters for 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 BeanWriter will write.

H

hashCode() - Method in class org.klojang.path.Path

I

identity() - Static method in interface org.klojang.invoke.BeanValueTransformer: The no-op transformer.
illegalAssignment(Object) - Method in class org.klojang.invoke.Setter: Generates an IllegalAssignmentException indicating that the specified value cannot be assigned to the property encapsulated by this Setter.
IllegalAssignmentException - Exception Class in org.klojang.invoke: Thrown by a BeanWriter if 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 MapBuilder for 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 BeanReader or written by a BeanWriter.
INDEX_EXPECTED - Enum constant in enum class org.klojang.path.ErrorCode: Indicates that the PathWalker had arrived on a list or array, so expected the next segment in the Path to 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 PathWalker encountered an array index in the Path, 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 PathWalker encountered an array index in the Path that 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.
isDeepNotEmpty() - Method in class org.klojang.path.Path: Returns true if this is a non-empty Path, consisting only of non-null, non-empty of path segments.
isEmpty() - Method in class org.klojang.path.Path: Returns true if this is an empty Path, 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 Iterator over 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 KeyDeserializer failed to deserialize a path segment into a map key.
KeyDeserializationException - Exception Class in org.klojang.path: Thrown by a KeyDeserializer if 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 MapBuilder that 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 PathWalker encountered a segment that did not correspond to any key of the Map it was processing.
NO_SUCH_PROPERTY - Enum constant in enum class org.klojang.path.ErrorCode: Indicates that the PathWalker encountered 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 BeanReader is created for a class with zero public getters, or if they were all excluded while constructing the BeanReader.
NoPublicSettersException - Exception Class in org.klojang.invoke: Thrown if a BeanWriter is created for a class with zero public setters, or if they were all excluded while constructing the BeanWriter.
noSuchProperty(Object, String) - Static method in exception class org.klojang.invoke.NoSuchPropertyException: Returns a NoSuchPropertyException for 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 PathWalker attempted to modify a List or Map and the List or Map responded by throwing an UnsupportedOperationException.

O

of(String) - Static method in class org.klojang.path.Path: Returns a Path consisting of a single segment.
of(String...) - Static method in class org.klojang.path.Path: Returns a Path consisting of the specified segments.
of(String, String) - Static method in class org.klojang.path.Path: Returns a Path consisting of the specified segments.
of(String, String, String) - Static method in class org.klojang.path.Path: Returns a Path consisting of the specified segments.
of(String, String, String, String) - Static method in class org.klojang.path.Path: Returns a Path consisting of the specified segments.
of(String, String, String, String, String) - Static method in class org.klojang.path.Path: Returns a Path consisting of the specified segments.
org.klojang.invoke - module org.klojang.invoke: Klojang Invoke is a module focused on 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: Returns a Path with all segments of this Path except the last segment.
Path - Class in org.klojang.path: Specifies a path to a value within an object.
PathWalker - Class in org.klojang.path: A PathWalker lets you read and write deeply nested values using Path objects.
PathWalker(String...) - Constructor for class org.klojang.path.PathWalker: Creates a PathWalker for the specified paths.
PathWalker(List<Path>) - Constructor for class org.klojang.path.PathWalker: Creates a PathWalker for the specified paths.
PathWalker(List<Path>, boolean) - Constructor for class org.klojang.path.PathWalker: Creates a PathWalker for the specified paths.
PathWalker(List<Path>, boolean, KeyDeserializer) - Constructor for class org.klojang.path.PathWalker: Creates a PathWalker for the specified paths.
PathWalker(Path...) - Constructor for class org.klojang.path.PathWalker: Creates a PathWalker for the specified paths.
PathWalkerException - Exception Class in org.klojang.path: Thrown by a PathWalker if a path-read or path-write error occurs.
poll(String) - Method in class org.klojang.path.util.MapBuilder: Returns a Result object containing the value of the specified path, or Result.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 Path with 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 Path in 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: Assembles, caches and supplies setters for classes.
shift() - Method in class org.klojang.path.Path: Returns a Path with all segments of this Path except 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 Stream of path segments.
subPath(int) - Method in class org.klojang.path.Path: Returns a new Path starting with the segment at the specified array index.
subPath(int, int) - Method in class org.klojang.path.Path: Returns a new Path consisting of length segments starting with segment offset.

T

TERMINAL_VALUE - Enum constant in enum class org.klojang.path.ErrorCode: Indicates that the Path continued after having reached a terminal value (like null or a primitive value) or an opaque value (like a String).
toString() - Method in class org.klojang.path.Path: Returns this Path as a string, properly escaped.
toString() - Method in class org.klojang.path.util.MapBuilder: Returns a string representation of the map created thus far.
transform(T, String, Object) - Method in interface org.klojang.invoke.BeanValueTransformer: Transforms the value just retrieved from a bean, or to be set on a bean.
TYPE_MISMATCH - Enum constant in enum class org.klojang.path.ErrorCode: Indicates that the PathWalker could 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 PathWalker encountered 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 MapBuilder for 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 Map objects.
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 int properties on the bean class.
withString(String...) - Method in class org.klojang.invoke.BeanReaderBuilder: Registers the specified names as String properties on the bean class.
withTransformer(BeanValueTransformer<T>) - Method in class org.klojang.invoke.BeanReaderBuilder
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 specified property to the specified value.
writeValues(Object, Object...) - Method in class org.klojang.path.PathWalker: Sets the values of the paths specified through the constructor.

A B C D E F G H I J K M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form