Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abs(Path) - Static method in class uk.blankaspect.common.filesystem.PathUtils
-
Converts the specified file-system location to a normalised absolute location and returns the result.
- absParent(Path) - Static method in class uk.blankaspect.common.filesystem.PathUtils
-
Converts the specified file-system location to a normalised absolute location and returns the parent of the resulting location.
- absString(Path) - Static method in class uk.blankaspect.common.filesystem.PathUtils
-
Converts the specified file-system location to a normalised absolute location and returns a string representation of the resulting location.
- absStringStd(Path) - Static method in class uk.blankaspect.common.filesystem.PathUtils
-
Converts the specified file-system location to a normalised absolute location and returns a string representation of the resulting location in which the system-dependent separators between adjacent components are replaced by Unix separators,
'/'
. - AbstractNode - Class in uk.blankaspect.common.basictree
-
This is the abstract base class of a node of a tree.
- AbstractNode(AbstractNode) - Constructor for class uk.blankaspect.common.basictree.AbstractNode
-
Creates a new instance of a node with the specified parent.
- add(String, AbstractNode) - Method in class uk.blankaspect.common.basictree.MapNode
-
Adds a key–value pair with the specified key and value to this map node.
- add(AbstractNode) - Method in class uk.blankaspect.common.basictree.ListNode
-
Adds the specified node to the end of the list of elements of this list node.
- add(AbstractNode) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Adds a key–value pair with the specified value and a key that is generated by the key-generator function to the map node that is associated with this generator.
- add(AbstractNode, NodeMessage.Kind, String, Object...) - Method in class uk.blankaspect.common.basictree.NodeMessage.List
-
Creates a new message with the specified attributes and adds it to this list.
- add(AbstractNode, NodeMessage.Kind, String, Throwable, Object...) - Method in class uk.blankaspect.common.basictree.NodeMessage.List
-
Creates a new message with the specified attributes and adds it to this list.
- add(AbstractNode, NodeMessage.Kind, Throwable) - Method in class uk.blankaspect.common.basictree.NodeMessage.List
-
Creates a new message with the specified attributes and adds it to this list.
- add(MapNode.Pair) - Method in class uk.blankaspect.common.basictree.MapNode
-
Adds the specified key–value pair to this map node.
- addBoolean(boolean) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a Boolean node with the specified value, adds it to the end of of the list of elements of this list node and returns it.
- addBoolean(boolean) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a Boolean node, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addBoolean(String, boolean) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a Boolean node, adds it to this map node as a key–value pair with the specified key and returns it.
- addBooleans(boolean...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of Boolean nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addBooleans(Iterable<Boolean>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of Boolean nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addBooleans(String, boolean...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of Boolean nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addBooleans(String, Iterable<Boolean>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of Boolean nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addDouble(double) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a 'double' node with the specified value, adds it to the end of the list of elements of this list node and returns it.
- addDouble(double) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a 'double' node, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addDouble(String, double) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a 'double' node, adds it to this map node as a key–value pair with the specified key and returns it.
- addDoubles(double...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of 'double' nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addDoubles(Iterable<Double>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of 'double' nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addDoubles(String, double...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of 'double' nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addDoubles(String, Iterable<Double>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of 'double' nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addElements(Iterable<? extends AbstractNode>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Adds the specified nodes to the end of the list of elements of this list node.
- addElements(AbstractNode...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Adds the specified nodes to the end of the list of elements of this list node.
- addIfAbsent(String, T) - Method in class uk.blankaspect.common.basictree.MapNode
-
Adds a key–value pair with the specified key and value to this map node if it does not already contain a KV pair with the specified key.
- addInt(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of an 'int' node with the specified value, adds it to the end of the list of elements of this list node and returns it.
- addInt(int) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of an 'int' node, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addInt(String, int) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of an 'int' node, adds it to this map node as a key–value pair with the specified key and returns it.
- addInts(int...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of 'int' nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addInts(Iterable<Integer>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of 'int' nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addInts(String, int...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of 'int' nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addInts(String, Iterable<Integer>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of 'int' nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addList(Iterable<? extends AbstractNode>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a list node with the specified elements, adds it to the end of the list of elements of this list node and returns it.
- addList(Iterable<? extends AbstractNode>) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a list node that contains the specified elements, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addList(String, Iterable<? extends AbstractNode>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node that contains the specified elements, adds it to this map node as a key–value pair with the specified key and returns it.
- addList(String, AbstractNode...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node that contains the specified elements, adds it to this map node as a key–value pair with the specified key and returns it.
- addList(AbstractNode...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a list node with the specified elements, adds it to the end of the list of elements of this list node and returns it.
- addList(AbstractNode...) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a list node that contains the specified elements, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addLong(long) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a 'long' node with the specified value, adds it to the end of the list of elements of this list node and returns it.
- addLong(long) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a 'long' node, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addLong(String, long) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a 'long' node, adds it to this map node as a key–value pair with the specified key and returns it.
- addLongs(long...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of 'long' nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addLongs(Iterable<Long>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of 'long' nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addLongs(String, long...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of 'long' nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addLongs(String, Iterable<Long>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of 'long' nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addMap(Iterable<? extends MapNode.Pair>) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a map node that contains the specified pairs of keys and values, adds the new map node to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addMap(String, Iterable<? extends MapNode.Pair>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that contains the specified pairs of keys and values, adds the new map node to this map node as a key–value pair with the specified key and returns it.
- addMap(String, Map<String, AbstractNode>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that contains the specified pairs of keys and values, adds the new map node to this map node as a key–value pair with the specified key and returns it.
- addMap(String, MapNode.Pair...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that contains the specified pairs of keys and values, adds the new map node to this map node as a key–value pair with the specified key and returns it.
- addMap(Map<String, AbstractNode>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a map node with the specified key–value pairs, adds it to the end of the list of elements of this list node and returns it.
- addMap(Map<String, AbstractNode>) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a map node that contains the specified pairs of keys and values, adds the new map node to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addMap(MapNode.Pair...) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a map node that contains the specified pairs of keys and values, adds the new map node to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addNull() - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a null node and adds it to the end of the list of elements of this list node.
- addNull() - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a null node, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addNull(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a null node, adds it to this map node as a key–value pair with the specified key and returns it.
- addPairs(Iterable<? extends MapNode.Pair>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Adds the specified key–value pairs to the key–value pairs of this map node.
- addPairs(Map<String, AbstractNode>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Adds the specified pairs of keys and values to the key–value pairs of this map node.
- addPairs(MapNode.Pair...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Adds the specified key–value pairs to the key–value pairs of this map node.
- addString(String) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a string node with the specified value, adds it to the end of the list of elements of this list node and returns it.
- addString(String) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a string node, adds it to the map node that is associated with this generator as a key–value pair with a key that is generated by the key-generator function, and returns the new node.
- addString(String, String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a string node, adds it to this map node as a key–value pair with the specified key and returns it.
- addStrings(Iterable<String>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of string nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addStrings(String...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates new instances of string nodes with the specified values and adds them to the end of the list of elements of this list node, preserving the order of the values.
- addStrings(String, Iterable<String>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of string nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- addStrings(String, String...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a list node whose elements are new instances of string nodes with the specified values, adds the list node to this map node as a key–value pair with the specified key and returns it.
- ALWAYS - Enum constant in enum class uk.blankaspect.common.json.NewLineBeforeLeftBracket
-
Always write a new line (LF, U+000A) before the opening bracket of a JSON array or the opening brace of a JSON object.
- ANY - Static variable in class uk.blankaspect.common.basictree.NodeType
-
The root of the node-type hierarchy.
- anyMatch(Element) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if the specified XML element matches any kind of JSON-XML element. - append(char, JsonText.Token) - Method in class uk.blankaspect.common.json.JsonText
-
Appends the specified character to this JSON text, and adds a new span for the character that associates it with the specified token.
- append(CharSequence, JsonText.Token) - Method in class uk.blankaspect.common.json.JsonText
-
Appends the specified text to this JSON text, and adds a new span for the text that associates it with the specified token.
- appendNewLine() - Method in class uk.blankaspect.common.json.JsonText
-
If this JSON text is not empty, a line-feed character (U+000A) is appended to it and a new span for it is added to the current line.
- appendSpace() - Method in class uk.blankaspect.common.json.JsonText
-
Appends a single space character (U+0020) to this JSON text, and adds a new span for the space.
- appendSpaces(int) - Method in class uk.blankaspect.common.json.JsonText
-
Appends the specified number of space characters (U+0020) to this JSON text, and adds a new span for the spaces.
- applyPrefix(String, String) - Static method in class uk.blankaspect.common.string.StringUtils
- ARRAY - Enum constant in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Corresponds to a JSON array.
- ARRAY_DELIMITER - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
The start or end delimiter of a JSON array.
- ARRAY_ELEMENT_SEPARATOR_CHAR - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The character that separates adjacent elements of a JSON array.
- ARRAY_END_CHAR - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The character that denotes the end of a JSON array.
- ARRAY_START_CHAR - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The character that denotes the start of a JSON array.
B
- BaseException - Exception Class in uk.blankaspect.common.exception2
-
This class implements a base checked exception.
- BaseException() - Constructor for exception class uk.blankaspect.common.exception2.BaseException
-
Creates a new instance of an exception with no detail message.
- BaseException(String, Object...) - Constructor for exception class uk.blankaspect.common.exception2.BaseException
-
Creates a new instance of an exception with the specified detail message.
- BaseException(String, Throwable) - Constructor for exception class uk.blankaspect.common.exception2.BaseException
-
Creates a new instance of an exception with the specified detail message and cause.
- BaseException(String, Throwable, Object...) - Constructor for exception class uk.blankaspect.common.exception2.BaseException
-
Creates a new instance of an exception with the specified detail message and cause.
- BOOLEAN - Enum constant in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Corresponds to a JSON Boolean value.
- BOOLEAN_VALUE - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
A JSON Boolean value.
- BooleanNode - Class in uk.blankaspect.common.basictree
-
This class implements a node that contains a Boolean value.
- BooleanNode(boolean) - Constructor for class uk.blankaspect.common.basictree.BooleanNode
-
Creates a new instance of a Boolean node that has no parent and has the specified value.
- BooleanNode(AbstractNode, boolean) - Constructor for class uk.blankaspect.common.basictree.BooleanNode
-
Creates a new instance of a Boolean node that has the specified parent and value.
- booleanNodes() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node that are Boolean nodes.
- booleanStream() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a stream of the elements of this list node that are Boolean nodes.
- buffer() - Method in class uk.blankaspect.common.json.JsonText
-
Returns the buffer that contains the JSON text.
- build() - Method in class uk.blankaspect.common.json.JsonGenerator.Builder
-
Creates and returns a new instance of a JSON generator that is initialised from the state of this builder.
- build() - Method in class uk.blankaspect.common.json.JsonParser.Builder
-
Creates and returns a new instance of a JSON parser that is initialised from the state of this builder.
- build() - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml.Builder
-
Creates and returns a new instance of a JSON generator that is initialised from the state of this builder.
- builder() - Static method in class uk.blankaspect.common.json.JsonGenerator
-
Creates and returns a new instance of a builder for a JSON generator.
- builder() - Static method in class uk.blankaspect.common.json.JsonParser
-
Creates and returns a new instance of a builder for a JSON parser.
- builder() - Static method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml
-
Creates and returns a new instance of a builder for a JSON generator.
C
- charToUnicodeHex(char) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Returns a representation of the Unicode value of the specified character as a string of four hexadecimal-digit characters.
- child(Element, int) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the element at the specified index in the sequence of JSON-XML elements that are children of the specified XML element.
- childIterator(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns an iterator over the JSON-XML elements that are children of the specified XML element.
- children(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns a list of the child nodes of the specified XML element that are JSON-XML elements.
- clean(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Removes all the descendant nodes of the specified XML element that are not JSON-XML elements.
- clear() - Method in class uk.blankaspect.common.basictree.ListNode
-
Removes all the elements of this list node.
- clear() - Method in class uk.blankaspect.common.basictree.MapNode
-
Removes all the key–value pairs of this map node.
- clone() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Creates and returns a copy of this node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.BooleanNode
-
Creates and returns a copy of this Boolean node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.DoubleNode
-
Creates and returns a copy of this 'double' node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.IntNode
-
Creates and returns a copy of this 'int' node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.ListNode
-
Creates and returns a deep copy of this list node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.LongNode
-
Creates and returns a copy of this 'long' node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.MapNode
-
Creates and returns a deep copy of this map node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.MapNode.Pair
-
Creates and returns a copy of this key–value pair.
- clone() - Method in class uk.blankaspect.common.basictree.NullNode
-
Creates and returns a copy of this null node that has no parent.
- clone() - Method in class uk.blankaspect.common.basictree.StringNode
-
Creates and returns a copy of this string node that has no parent.
- COMPACT - Enum constant in enum class uk.blankaspect.common.json.OutputMode
-
JSON text is written on a single line with a space between some tokens.
- COMPOUND_KINDS - Static variable in enum class uk.blankaspect.common.jsonxml.ElementKind
-
The kinds of element that correspond to compound JSON values.
- COMPOUND_NODE_TYPES - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The types of nodes that represent compound JSON values.
- containsIgnoreCase(String, Iterable<String>) - Static method in class uk.blankaspect.common.string.StringUtils
- containsText(Reader, CharSequence) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Returns
true
if the specified sequence of characters is found in the specified character stream. - containsText(Path, CharSequence) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Returns
true
if the specified sequence of characters is found in the specified file, which is expected to contain text with the UTF-8 character encoding. - convertLocations(Iterable<? extends File>) - Static method in class uk.blankaspect.common.filesystem.PathUtils
- copy(IElementFacade, IElementFacade, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Creates and returns a deep copy of the specified JSON-XML element.
- countChildren(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns a count of the child nodes of the specified XML element that are JSON-XML elements.
- countDescendants(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns a count of the descendant nodes of the specified XML element that are JSON-XML elements.
- createDocument(String, String) - Static method in class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Creates and returns a new instance of a XML document whose document element has the specified namespace URI and the specified qualified name.
- createElement(String) - Method in interface uk.blankaspect.common.jsonxml.IElementFacade
-
Creates and returns a new instance of a JSON-XML element whose name is the specified name or is derived from it in some way (for example, by applying a namespace prefix to it).
- createElement(String) - Method in class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Creates and returns a new instance of a JSON-XML element whose name is the specified name or is derived from it in some way (for example, by applying a namespace prefix to it).
- createElement(IElementFacade) - Method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Creates and returns a new instance of a JSON-XML element of this kind using the specified facade.
- createMessage(String, Object...) - Static method in exception class uk.blankaspect.common.exception2.BaseException
-
Creates a composite message from the specified message and replacement sequences, and returns the result.
- createMessage(String, String, Object...) - Static method in exception class uk.blankaspect.common.exception2.LocationException
-
Creates a composite message from the specified components, and returns the result.
- createMessage(String, Path, Object...) - Static method in exception class uk.blankaspect.common.exception2.FileException
-
Creates a composite message from the specified components, and returns the result.
D
- DEBUG - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
A debug message.
- DEFAULT_GENERATED_KEY_PREFIX - Static variable in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
The prefix of a key that is generated by the default key-generator function.
- DENSE - Enum constant in enum class uk.blankaspect.common.json.OutputMode
-
JSON text is written on a single line with no space between tokens.
- DoubleNode - Class in uk.blankaspect.common.basictree
-
This class implements a node that contains a double-precision floating-point number.
- DoubleNode(double) - Constructor for class uk.blankaspect.common.basictree.DoubleNode
-
Creates a new instance of a 'double' node that has no parent and has the specified value.
- DoubleNode(AbstractNode, double) - Constructor for class uk.blankaspect.common.basictree.DoubleNode
-
Creates a new instance of a 'double' node that has the specified parent and value.
- doubleNodes() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node that are 'double' nodes.
- doubleStream() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a stream of the elements of this list node that are 'double' nodes.
E
- ELEMENT_SEPARATOR_CHAR - Static variable in class uk.blankaspect.common.basictree.ListNode
-
The character that separates adjacent elements in the string representation of a list node.
- elementFacade(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns a new instance of an element facade that is associated with the owner document of the specified XML element.
- elementFacade(IElementFacade) - Method in class uk.blankaspect.common.json.JsonParser.Builder
-
Sets the interface through which XML elements are created and their attributes accessed.
- elementFacade(IElementFacade) - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml.Builder
-
Sets the interface through which the name and value attributes of JSON-XML elements are accessed.
- ElementKind - Enum Class in uk.blankaspect.common.jsonxml
-
This is an enumeration of the kinds of element that may appear in a tree of JSON-XML.
- ElementKind.UnexpectedKindException - Exception Class in uk.blankaspect.common.jsonxml
-
This class implements an unchecked exception that may be thrown if an XML element is encountered where a JSON-XML element is expected.
- EMPTY - Static variable in exception class uk.blankaspect.common.exception2.BaseException
-
An empty exception that may be tested for identity.
- END_CHAR - Static variable in class uk.blankaspect.common.basictree.ListNode
-
The character that denotes the end of the string representation of a list node.
- END_CHAR - Static variable in class uk.blankaspect.common.basictree.MapNode
-
The character that denotes the end of the string representation of a map node.
- END_CHAR - Static variable in class uk.blankaspect.common.basictree.StringNode
-
The character that denotes the end of the string representation of a string node.
- endOffset() - Method in interface uk.blankaspect.common.text.ITextLine
-
Returns the offset from the start of the text to the exclusive end of this line (that is, the character immediately after the end of this line).
- endOffset() - Method in interface uk.blankaspect.common.text.ITextSpan
-
Returns the offset from the start of the text to the exclusive end of this span (that is, the character immediately after the end of this span).
- equals(Object) - Method in class uk.blankaspect.common.basictree.BooleanNode
-
Returns
true
if the specified object is an instance ofBooleanNode
and it has the same value as this Boolean node. - equals(Object) - Method in class uk.blankaspect.common.basictree.DoubleNode
-
Returns
true
if the specified object is an instance ofDoubleNode
and it has the same value as this 'double' node. - equals(Object) - Method in class uk.blankaspect.common.basictree.IntNode
-
Returns
true
if the specified object is an instance ofIntNode
and it has the same value as this 'int' node. - equals(Object) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns
true
if the specified object is an instance ofListNode
and this list node contains the same number of elements as the other list node and each element in this list node is equal to the element at the same index in the other list node. - equals(Object) - Method in class uk.blankaspect.common.basictree.LongNode
-
Returns
true
if the specified object is an instance ofLongNode
and it has the same value as this 'long' node. - equals(Object) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if the specified object is an instance ofMapNode
and this map node contains the same number of key–value pairs as the other map node and for each KV pair in this map node, kv1, there is a KV pair in the other map node, kv2, for which the keys of kv1 and kv2 are equal and the values of kv1 and kv2 are equal. - equals(Object) - Method in class uk.blankaspect.common.basictree.MapNode.Pair
-
Returns
true
if the specified object is an instance ofPair
and the keys and values of the two pairs are equal to each other. - equals(Object) - Method in class uk.blankaspect.common.basictree.NullNode
-
Returns
true
if the specified object is an instance ofNullNode
. - equals(Object) - Method in class uk.blankaspect.common.basictree.StringNode
-
Returns
true
if the specified object is an instance ofStringNode
and it has the same value as this string node. - equals(Object) - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Indicates whether some other object is "equal to" this one.
- equals(Element, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Performs a deep comparison of the specified pair of JSON-XML elements and returns
true
if the elements are equal to each other. - equals(IElementFacade, Element, IElementFacade, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Performs a deep comparison of the specified pair of JSON-XML elements and returns
true
if the elements are equal to each other. - equals(IElementFacade, Element, IElementFacade, Element, boolean) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Performs a deep comparison of the specified pair of JSON-XML elements and returns
true
if the elements are equal to each other. - equalsIgnoreNS(Element, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Performs a deep comparison of the specified pair of JSON-XML elements and returns
true
if the elements are equal to each other. - equalsIgnoreNS(Element, Element, boolean) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Performs a deep comparison of the specified pair of JSON-XML elements and returns
true
if the elements are equal to each other. - ERROR - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
An error message.
- escape(CharSequence) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Transforms the specified character sequence to a string, replacing each occurrence of one of the following characters with an escape sequence, and returns the resulting string: a quotation mark ("), a reverse solidus (\), a character outside the range U+0020 to U+007E inclusive.
- escape(CharSequence, boolean) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Transforms the specified character sequence to a string, replacing each occurrence of one of the following characters with an escape sequence, and returns the resulting string: a quotation mark ("), a reverse solidus (\), a character in the range U+0000 to U+001F inclusive, a character in the range U+007F to U+009F inclusive, optionally, a character whose code is greater than or equal to U+00A0.
- escape(CharSequence, String) - Static method in class uk.blankaspect.common.string.StringUtils
- ESCAPE_MAPPINGS - Static variable in class uk.blankaspect.common.basictree.StringNode
-
Mappings from literal characters to their corresponding characters in an escape sequence.
- ESCAPE_PREFIX - Static variable in class uk.blankaspect.common.basictree.StringNode
-
The string with which an escape sequence begins.
- ESCAPE_PREFIX_CHAR - Static variable in class uk.blankaspect.common.basictree.StringNode
-
The character with which an escape sequence begins.
- ESCAPE_PREFIX_CHAR - Static variable in class uk.blankaspect.common.string.StringUtils
-
The prefix that is recognised by the
StringUtils.escape(CharSequence, String)
method. - escapeAndQuote(CharSequence) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Calls
StringNode.escape(CharSequence)
on the specified character sequence, encloses the returned string in quotation marks and returns the resulting string. - escapeAndQuote(CharSequence, boolean) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Calls
StringNode.escape(CharSequence, boolean)
on the specified character sequence, encloses the returned string in quotation marks and returns the resulting string. - EXCEPT_AFTER_NAME - Enum constant in enum class uk.blankaspect.common.json.NewLineBeforeLeftBracket
-
Write a new line (LF, U+000A) before the opening bracket of a JSON array or the opening brace of a JSON object except when the bracket or brace occurs after the name of a member of a JSON object.
- EXCEPTION - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Component
-
The exception that is associated with the message.
- EXPANDED - Enum constant in enum class uk.blankaspect.common.json.OutputMode
-
JSON text may be written on multiple lines with a space between some tokens.
- extractLines(CharSequence) - Static method in class uk.blankaspect.common.string.StringUtils
-
Splits the specified text at line separators and returns the resulting list of lines.
F
- FATAL - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
A fatal error message.
- FileException - Exception Class in uk.blankaspect.common.exception2
-
This class implements a checked exception that is associated with the location of a file or directory.
- FileException(String, Throwable, Path, Object...) - Constructor for exception class uk.blankaspect.common.exception2.FileException
-
Creates a new instance of an exception with the specified detail message, cause and associated location.
- FileException(String, Path, Object...) - Constructor for exception class uk.blankaspect.common.exception2.FileException
-
Creates a new instance of an exception with the specified detail message and associated location.
- FileException(BaseException, Path, Object...) - Constructor for exception class uk.blankaspect.common.exception2.FileException
-
Creates a new instance of an exception from the detail message and cause of the specified exception and the specified location.
- findKey(AbstractNode) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the key that is associated with the specified value in this map node.
- findNode(T, Iterable<U>, BiPredicate<T, U>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Searches a tree of
ITreeNode
s, starting from the specified node, for a node whose path from the root matches the specified path descriptor. - findNode(T, Function<T, List<T>>, Iterable<U>, BiPredicate<T, U>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Searches a tree, starting from the specified node, for a node whose path from the root matches the specified path descriptor.
- firstCharsToLowerCase(String) - Static method in class uk.blankaspect.common.string.StringUtils
- firstCharsToUpperCase(String) - Static method in class uk.blankaspect.common.string.StringUtils
- firstCharToLowerCase(String) - Static method in class uk.blankaspect.common.string.StringUtils
- firstCharToUpperCase(String) - Static method in class uk.blankaspect.common.string.StringUtils
- forNode(MapNode) - Static method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates and returns a new instance of a generator of keys for the specified map node.
G
- generate(Element) - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml
-
Generates and returns JSON text for the specified XML element in accordance with the properties of this generator: output mode, new line before left bracket parameter, indent increment, maximum line length.
- generate(AbstractNode) - Method in class uk.blankaspect.common.json.JsonGenerator
-
Generates and returns JSON text for the specified value in accordance with the properties of this generator: output mode, new line before left bracket parameter, indent increment, maximum line length.
- get(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index.
- get(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the value of the key–value pair of this map node with the specified key.
- getAttribute(Element, String) - Method in interface uk.blankaspect.common.jsonxml.IElementFacade
-
Returns the value of a named attribute of the specified element.
- getAttribute(Element, String) - Method in class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Returns the value of a named attribute of the specified element.
- getAttrIgnoreNS(Element, String) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the value of the attribute of the specified XML element with the specified attribute name, ignoring any namespace prefix of the attribute.
- getBoolean(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as a Boolean node.
- getBoolean(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the Boolean node that is associated with the specified key in this map node.
- getBoolean(String, boolean) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the Boolean node that is associated with the specified key in this map node.
- getBooleanArray() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as an array of
boolean
s. - getBooleanList() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as a list of
Boolean
s. - getBooleanNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the Boolean node that is associated with the specified key in this map node.
- getChildren() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Returns a list of the children of this node.
- getChildren() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node.
- getChildren() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns a list of the values of the key–value pairs of this map node.
- getChildren() - Method in class uk.blankaspect.common.basictree.NodeType
-
Returns an unmodifiable list of the child types of this node type.
- getChildren() - Method in interface uk.blankaspect.common.tree.ITreeNode
-
Returns a list of the children of this node.
- getColumnIndex() - Method in exception class uk.blankaspect.common.json.JsonParser.ParseException
-
Returns the zero-based index of the column of the input text at which the exception occurred.
- getDepth(T) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns the depth of the specified node (ie, the number of levels below the root node of the tree to which the specified node belongs).
- getDepth(T, Function<T, T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns the depth of the specified node (ie, the number of levels below the root node of the tree to which the specified node belongs).
- getDepth(T, T) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns the number of levels of the specified node below the specified root node.
- getDepth(T, T, Function<T, T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns the number of levels of the specified node below the specified root node.
- getDocument() - Method in class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Returns the XML document that is associated with the elements and attributes that are created by the methods of this facade.
- getDouble(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as a 'double' node.
- getDouble(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'double' node that is associated with the specified key in this map node.
- getDouble(String, double) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'double' node that is associated with the specified key in this map node.
- getDoubleArray() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as an array of
double
s. - getDoubleList() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as a list of
Double
s. - getDoubleNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the 'double' node that is associated with the specified key in this map node.
- getElement() - Method in exception class uk.blankaspect.common.jsonxml.JsonGeneratorXml.UnrecognisedElementException
-
Returns the element that is associated with this exception.
- getElements() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns an unmodifiable list of the elements of this list node.
- getEnumValue(Class<E>, String, E) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the constant of the specified enumeration type whose name matches the underlying value of the string node that is associated with the specified key in this map node.
- getEnumValue(Class<E>, String, Function<E, String>, E) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the constant of the specified enumeration type that, after the specified converter has been applied to it, matches the underlying value of the string node that is associated with the specified key in this map node.
- getException() - Method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns the exception that is associated with this message.
- getIndices(T, int) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns a list of indices to the specified node from the root of the tree to which it belongs.
- getIndices(T, int, Function<T, T>, Function<T, List<T>>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns a list of indices to the specified node from the root of the tree to which it belongs.
- getIndices(T, T, boolean, int) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns a list of indices of the path from the specified root node to the specified node, which is assumed to be a descendant of the specified root.
- getIndices(T, T, boolean, int, Function<T, T>, Function<T, List<T>>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns a list of indices of the path from the specified root node to the specified node, which is assumed to be a descendant of the specified root.
- getInt(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as an 'int' node.
- getInt(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'int' node that is associated with the specified key in this map node.
- getInt(String, int) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'int' node that is associated with the specified key in this map node.
- getIntArray() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as an array of
int
s. - getIntList() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as a list of
Integer
s. - getIntNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the 'int' node that is associated with the specified key in this map node.
- getIntOrLong(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'int' node or 'long' node that is associated with the specified key in this map node.
- getIntOrLong(String, long) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'int' node or 'long' node that is associated with the specified key in this map node.
- getIntOrLongArray() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as an array of
long
s. - getIntOrLongList() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as a list of
Long
s. - getKey() - Method in class uk.blankaspect.common.basictree.MapNode.Pair
-
Returns the key of this key–value pair.
- getKeys() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns a list of the keys of the key–value pairs of this map node.
- getKind() - Method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns the kind of this message.
- getLineIndex() - Method in exception class uk.blankaspect.common.json.JsonParser.ParseException
-
Returns the zero-based index of the line of the input text at which the exception occurred.
- getList(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as a list node.
- getListIndex() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
If this node is an element of a list node, returns the index of the element in the list node's list of elements.
- getListNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the list node that is associated with the specified key in this map node.
- getLocation() - Method in exception class uk.blankaspect.common.exception2.FileException
-
Returns the location with which this exception is associated.
- getLong(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as a 'long' node.
- getLong(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'long' node that is associated with the specified key in this map node.
- getLong(String, long) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the 'long' node that is associated with the specified key in this map node.
- getLongArray() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as an array of
long
s. - getLongList() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as a list of
Long
s. - getLongNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the 'long' node that is associated with the specified key in this map node.
- getMap(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as a map node.
- getMapKey() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
If this node is the value of a key–value pair of a map node, returns the key that is associated with the value.
- getMapNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the map node that is associated with the specified key in this map node.
- getMaxLength(Iterable<? extends CharSequence>) - Static method in class uk.blankaspect.common.string.StringUtils
- getMaxLength(String...) - Static method in class uk.blankaspect.common.string.StringUtils
- getMessages() - Method in class uk.blankaspect.common.basictree.NodeMessage.List
-
Returns an unmodifiable list of the messages in this list.
- getName(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the value of the name attribute of the specified XML element, which corresponds to the name of a member of a JSON object.
- getName(IElementFacade, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the value of the name attribute of the specified XML element, which corresponds to the name of a member of a JSON object.
- getNameIgnoreNS(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the value of the name attribute of the specified XML element, ignoring any namespace prefix of the attribute.
- getNode() - Method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns the node that is associated with this message.
- getNodeClass() - Method in class uk.blankaspect.common.basictree.NodeType
-
Returns the class of node with which this node type is associated.
- getNodeType() - Method in exception class uk.blankaspect.common.basictree.NodeTypeException
-
Returns the node type that is associated with this exception.
- getNull(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as a null node.
- getNullNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the null node that is associated with the specified key in this map node.
- getNumberArray() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as an array of
double
s. - getNumberList() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as a list of
Double
s. - getNumElements() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the number of elements that this list node contains.
- getNumMessages() - Method in class uk.blankaspect.common.basictree.NodeMessage.List
-
Returns the number of messages in this list.
- getNumPairs() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the number of key–value pairs that this map node contains.
- getPairIterator() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns an iterator over the key–value pairs of this map node.
- getPairList() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns a list of the key–value pairs of this map node.
- getPairs() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns an unmodifiable map of the key–value pairs of this map node.
- getParent() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Returns the parent of this node.
- getParent() - Method in class uk.blankaspect.common.basictree.NodeType
-
Returns the parent type of this node type.
- getParent() - Method in interface uk.blankaspect.common.tree.ITreeNode
-
Returns the parent of this node.
- getPath(T) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns the path to the specified node from the root of the tree to which it belongs.
- getPath(T, Function<T, T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns the path to the specified node from the root of the tree to which it belongs.
- getPath(T, T) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns the path from the specified root node to the specified node, which is assumed to be a descendant of the specified root.
- getPath(T, T, Function<T, T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns the path from the specified root node to the specified node, which is assumed to be a descendant of the specified root.
- getPrefixFirst(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- getPrefixLast(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- getRoot(T) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns the root node of the tree to which the specified node belongs.
- getRoot(T, Function<T, T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns the root node of the tree to which the specified node belongs.
- getSiblings(T) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns a list of the siblings of the specified node.
- getSiblings(T, Function<T, T>, Function<T, List<T>>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns a list of the siblings of the specified node.
- getString(int) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the element of this list node at the specified index as a string node.
- getString(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the string node that is associated with the specified key in this map node.
- getString(String, String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the underlying value of the string node that is associated with the specified key in this map node.
- getStringArray() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as an array of strings.
- getStringList() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the underlying values of the elements of this list node as a list of strings.
- getStringNode(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the string node that is associated with the specified key in this map node.
- getSuffixAfterFirst(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- getSuffixAfterLast(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- getSuffixFirst(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- getSuffixLast(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- getText() - Method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns the text of this message.
- getToken(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml
-
Returns the JSON token that corresponds to the specified XML element.
- getToken(AbstractNode) - Static method in class uk.blankaspect.common.json.JsonGenerator
-
Returns the JSON token that corresponds to the specified value.
- getType() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Returns the type of this node.
- getType() - Method in class uk.blankaspect.common.basictree.BooleanNode
- getType() - Method in class uk.blankaspect.common.basictree.DoubleNode
- getType() - Method in class uk.blankaspect.common.basictree.IntNode
- getType() - Method in class uk.blankaspect.common.basictree.ListNode
- getType() - Method in class uk.blankaspect.common.basictree.LongNode
- getType() - Method in class uk.blankaspect.common.basictree.MapNode
- getType() - Method in class uk.blankaspect.common.basictree.NullNode
- getType() - Method in class uk.blankaspect.common.basictree.StringNode
- getValue() - Method in class uk.blankaspect.common.basictree.BooleanNode
-
Returns the value of this Boolean node.
- getValue() - Method in class uk.blankaspect.common.basictree.DoubleNode
-
Returns the value of this 'double' node.
- getValue() - Method in class uk.blankaspect.common.basictree.IntNode
-
Returns the value of this 'int' node.
- getValue() - Method in class uk.blankaspect.common.basictree.LongNode
-
Returns the value of this 'long' node.
- getValue() - Method in class uk.blankaspect.common.basictree.MapNode.Pair
-
Returns the value of this key–value pair.
- getValue() - Method in class uk.blankaspect.common.basictree.StringNode
-
Returns the value of this string node.
- getValue(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the value of the value attribute of the specified XML element, which corresponds to a JSON value.
- getValue(IElementFacade, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the value of the value attribute of the specified XML element, which corresponds to a JSON value.
- getValueIgnoreNS(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the value of the value attribute of the specified XML element, ignoring any namespace prefix of the attribute.
H
- hasBoolean(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is a Boolean node. - hasDouble(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is a 'double' node. - hasFatalError() - Method in class uk.blankaspect.common.basictree.NodeMessage.List
-
Returns
true
if this list contains at least one 'fatal error' message. - hashCode() - Method in class uk.blankaspect.common.basictree.BooleanNode
-
Returns the hash code of this Boolean node.
- hashCode() - Method in class uk.blankaspect.common.basictree.DoubleNode
-
Returns the hash code of this 'double' node.
- hashCode() - Method in class uk.blankaspect.common.basictree.IntNode
-
Returns the hash code of this 'int' node.
- hashCode() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the hash code of this list node, which is the hash code of its elements.
- hashCode() - Method in class uk.blankaspect.common.basictree.LongNode
-
Returns the hash code of this 'long' node.
- hashCode() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns the hash code of this map node, which is the hash code of its key–value pairs.
- hashCode() - Method in class uk.blankaspect.common.basictree.MapNode.Pair
-
Returns the hash code of this key–value pair.
- hashCode() - Method in class uk.blankaspect.common.basictree.NullNode
-
Returns the hash code of this null node.
- hashCode() - Method in class uk.blankaspect.common.basictree.StringNode
-
Returns the hash code of this string node.
- hashCode() - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Returns a hash code value for this object.
- hashCode(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns a deep hash code for the specified XML element.
- hashCode(IElementFacade, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns a deep hash code for the specified XML element.
- hashCode(IElementFacade, Element, boolean) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns a deep hash code for the specified XML element.
- hasInt(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is an 'int' node. - hasIntOrLong(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is either an 'int' node or a 'long' node. - hasKey(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair with the specified key. - hasList(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is a list node. - hasLong(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is a 'long' node. - hasMap(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is a map node. - hasNull(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is a null node. - hasString(String) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains a key–value pair whose key is the specified key and whose value is a string node. - HEX_DIGITS - Static variable in class uk.blankaspect.common.basictree.StringNode
-
Hexadecimal-digit characters.
I
- IElementFacade - Interface in uk.blankaspect.common.jsonxml
-
This interface defines methods that can be used to create JSON-XML elements and to access the attributes of JSON-XML elements.
- indentIncrement(int) - Method in class uk.blankaspect.common.json.JsonGenerator.Builder
-
Sets the number of spaces by which indentation is increased from one level to the next.
- indentIncrement(int) - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml.Builder
-
Sets the number of spaces by which indentation is increased from one level to the next.
- indexOf(AbstractNode) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns the index of the specified node in the list of the elements of this list node.
- indexOfIgnoreCase(String, List<String>) - Static method in class uk.blankaspect.common.string.StringUtils
- INFO - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
An informative message.
- IntNode - Class in uk.blankaspect.common.basictree
-
This class implements a node that contains an integer.
- IntNode(int) - Constructor for class uk.blankaspect.common.basictree.IntNode
-
Creates a new instance of an 'int' node that has no parent and has the specified value.
- IntNode(AbstractNode, int) - Constructor for class uk.blankaspect.common.basictree.IntNode
-
Creates a new instance of an 'int' node that has the specified parent and value.
- intNodes() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node that are 'int' nodes.
- intStream() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a stream of the elements of this list node that are 'int' nodes.
- is(NodeType) - Method in class uk.blankaspect.common.basictree.NodeType
-
Returns
true
if this node type is identical to or a subtype (ie, descendant) of the specified node type. - isAncestor(T, T) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns
true
if the specified node is an ancestor of the specified target node. - isAncestor(T, T, boolean) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns
true
if the specified node is an ancestor of the specified target node or, optionally, if the node is identical to the target. - isAncestor(T, T, boolean, Function<T, T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns
true
if the specified node is an ancestor of the specified target node or, optionally, if the node is identical to the target. - isAncestor(T, T, Function<T, T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns
true
if the specified node is an ancestor of the specified target node. - isAnyOf(Iterable<NodeType>) - Method in class uk.blankaspect.common.basictree.NodeType
-
Returns
true
if this node type is identical to or a subtype (ie, descendant) of any of the specified node types. - isAnyOf(NodeType...) - Method in class uk.blankaspect.common.basictree.NodeType
-
Returns
true
if this node type is identical to or a subtype (ie, descendant) of any of the specified node types. - isCompound() - Method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if this kind of JSON-XML element corresponds to a compound JSON value (array or object). - isCompound(Element) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if the specified XML element matches a kind of JSON-XML element that corresponds to a compound JSON value (array or object). - isCompoundJsonValue(AbstractNode) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Returns
true
if the specified node corresponds to a compound JSON value (ie, an array or object). - isContainer() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.BooleanNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.DoubleNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.IntNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.LongNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.NullNode
-
Returns
true
if this node can contain other nodes. - isContainer() - Method in class uk.blankaspect.common.basictree.StringNode
-
Returns
true
if this node can contain other nodes. - isEmpty() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns
true
if this list node contains no elements. - isEmpty() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns
true
if this map node contains no key–value pairs. - isEmpty() - Method in class uk.blankaspect.common.basictree.NodeMessage.List
-
Returns
true
if this list contains no messages. - isEmpty() - Method in class uk.blankaspect.common.json.JsonText.Line
-
Returns
true
if this line is empty. - isError() - Method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns
true
if the kind of this message is an error or a fatal error. - isJsonContainer(AbstractNode) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Deprecated.
- isJsonNumber(AbstractNode) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Returns
true
if the specified node corresponds to a JSON number. - isJsonValue(AbstractNode) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Returns
true
if the specified node corresponds to a JSON value. - isLeaf() - Method in interface uk.blankaspect.common.tree.ITreeNode
-
Returns
true
if this node is a leaf node (ie, it has no children). - isNullOrBlank(String) - Static method in class uk.blankaspect.common.string.StringUtils
- isNullOrEmpty(String) - Static method in class uk.blankaspect.common.string.StringUtils
-
Returns
true
if the specified string isnull
or empty. - isRoot() - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Returns
true
if this node is the root of the tree to which it belongs. - isSimple() - Method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if this kind of JSON-XML element corresponds to a simple JSON value (null, Boolean, number or string). - isSimple(Element) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if the specified XML element matches a kind of JSON-XML element that corresponds to a simple JSON value (null, Boolean, number or string). - isSimpleJsonValue(AbstractNode) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Returns
true
if the specified node corresponds to a simple JSON value (ie, a null, a Boolean, a number or a string). - ITEM_SEPARATOR - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
The separator between adjacent elements of a JSON array or adjacent members of a JSON object.
- iterator() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns an iterator over the elements of this list node.
- ITextLine - Interface in uk.blankaspect.common.text
-
This interface defines the methods that must be implemented by a class that represents a line of text.
- ITextSpan - Interface in uk.blankaspect.common.text
-
This interface defines the methods that must be implemented by a class that represents a span of text (that is, a sequence of characters).
- ITreeNode<T> - Interface in uk.blankaspect.common.tree
-
This interface defines the methods that must be implemented by a node of a tree that can be used with the methods of
TreeUtils
.
J
- join(char, boolean, Iterable<? extends CharSequence>) - Static method in class uk.blankaspect.common.string.StringUtils
- join(char, boolean, String...) - Static method in class uk.blankaspect.common.string.StringUtils
- join(char, Iterable<? extends CharSequence>) - Static method in class uk.blankaspect.common.string.StringUtils
- join(char, String...) - Static method in class uk.blankaspect.common.string.StringUtils
- join(CharSequence, boolean, Iterable<? extends CharSequence>) - Static method in class uk.blankaspect.common.string.StringUtils
- join(CharSequence, boolean, String...) - Static method in class uk.blankaspect.common.string.StringUtils
- join(CharSequence, Iterable<? extends CharSequence>) - Static method in class uk.blankaspect.common.string.StringUtils
- join(CharSequence, String...) - Static method in class uk.blankaspect.common.string.StringUtils
- join(Iterable<? extends Path>) - Static method in class uk.blankaspect.common.filesystem.PathUtils
-
Concatenates the string representations of the specified locations, with adjacent locations separated by the system-dependent separator character, and returns the resulting string.
- join(Path...) - Static method in class uk.blankaspect.common.filesystem.PathUtils
-
Concatenates the string representations of the specified locations, with adjacent locations separated by the system-dependent separator character, and returns the resulting string.
- JsonConstants - Interface in uk.blankaspect.common.json
-
This interface defines constants that relate to JSON.
- JsonGenerator - Class in uk.blankaspect.common.json
-
This class implements a generator that transforms a tree of values that are represented by nodes into JSON text.
- JsonGenerator.Builder - Class in uk.blankaspect.common.json
-
This class implements a builder for a JSON generator.
- JsonGeneratorXml - Class in uk.blankaspect.common.jsonxml
-
This class implements a generator that transforms a tree of values that are represented by XML elements into JSON text.
- JsonGeneratorXml.Builder - Class in uk.blankaspect.common.jsonxml
-
This class implements a builder for a JSON generator.
- JsonGeneratorXml.UnrecognisedElementException - Exception Class in uk.blankaspect.common.jsonxml
-
This class implements an unchecked exception that is thrown in response to an unrecognised XML element.
- JsonParser - Class in uk.blankaspect.common.json
-
This class implements a parser that transforms JSON text into either a tree of nodes or a tree of XML elements:
- JsonParser.Builder - Class in uk.blankaspect.common.json
-
This class implements a builder for a JSON parser.
- JsonParser.ParseException - Exception Class in uk.blankaspect.common.json
-
This class implements an exception that is thrown if an error occurs when parsing JSON text.
- JsonText - Class in uk.blankaspect.common.json
-
This class implements a buffer for JSON text.
- JsonText() - Constructor for class uk.blankaspect.common.json.JsonText
-
Creates a new instance of JSON text.
- JsonText.Line - Class in uk.blankaspect.common.json
-
This class encapsulates a line of text, which consists of a sequence of spans.
- JsonText.Span - Record Class in uk.blankaspect.common.json
-
This record encapsulates a subsequence of the text of a
JsonText.Line
that is associated with a JSON token. - JsonText.Token - Enum Class in uk.blankaspect.common.json
-
This is an enumeration of the tokens that may be associated with elements of JSON text.
- JsonUtils - Class in uk.blankaspect.common.json
-
This class contains utility methods that relate to JSON.
- JsonXmlUtils - Class in uk.blankaspect.common.jsonxml
-
This class provides utility methods that are related to JSON-XML.
- JsonXmlValidator - Class in uk.blankaspect.common.jsonxml
-
This class provides some
static
methods for validating a tree of JSON-XML elements against an XML Schema (XSD).
K
- key() - Method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns the key of this kind of JSON-XML element.
- KEY_VALUE_SEPARATOR_CHAR - Static variable in class uk.blankaspect.common.basictree.MapNode
-
The character that separates the key and value of a KV pair in the string representation of a map node.
- keyGenerator() - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Returns the function that is used to generate keys for the associated map node.
- keyGenerator(Function<MapNode, String>) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Sets the function that is used to generate keys for the associated map node.
- keyIndex() - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Returns the next value of the auto-incrementing index that is used by the default key-generator function.
- keyIndex(int) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Sets the next value of the auto-incrementing index that is used by the default key-generator function.
- keyPrefix() - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Returns the prefix of the keys that are generated by the default key-generator function.
- keyPrefix(String) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Sets the prefix of the keys that are generated by the default key-generator function.
- keys() - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Returns a list of the keys that are associated with this span.
- keys() - Method in interface uk.blankaspect.common.text.ITextSpan
-
Returns a list of the keys that are associated with this span.
- keyToString(CharSequence) - Static method in class uk.blankaspect.common.basictree.MapNode
-
Returns a string representation of the specified key for a map node.
- keyToString(CharSequence, boolean) - Static method in class uk.blankaspect.common.basictree.MapNode
-
Returns a string representation of the specified key for a map node.
- KIND - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Component
-
The kind of the message.
L
- lastLine() - Method in class uk.blankaspect.common.json.JsonText
-
Returns the last line of this JSON text within the buffer.
- lastLineLength() - Method in class uk.blankaspect.common.json.JsonText
-
Returns the length of the last line of this JSON text.
- length() - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Returns the value of the
length
record component. - length() - Method in interface uk.blankaspect.common.text.ITextLine
-
Returns the length of this line.
- length() - Method in interface uk.blankaspect.common.text.ITextSpan
-
Returns the length of this span.
- line() - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Returns the value of the
line
record component. - lines() - Method in class uk.blankaspect.common.json.JsonText
-
Returns a list of the lines of this JSON text within the buffer.
- List() - Constructor for class uk.blankaspect.common.basictree.NodeMessage.List
-
Creates a new instance of a list of node-related messages.
- ListNode - Class in uk.blankaspect.common.basictree
- ListNode() - Constructor for class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a list node that has no parent and initially contains no elements.
- ListNode(Iterable<? extends AbstractNode>) - Constructor for class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a list node that has no parent and initially contains the specified elements.
- ListNode(AbstractNode) - Constructor for class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a list node that has the specified parent and initially contains no elements.
- ListNode(AbstractNode, Iterable<? extends AbstractNode>) - Constructor for class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a list node that has the specified parent and initially contains the specified elements.
- ListNode(AbstractNode, AbstractNode...) - Constructor for class uk.blankaspect.common.basictree.ListNode
-
Creates a new instance of a list node that has the specified parent and initially contains the specified elements.
- listNodes() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node that are list nodes.
- listStream() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a stream of the elements of this list node that are list nodes.
- LocationException - Exception Class in uk.blankaspect.common.exception2
-
This class implements an exception that relates to a location.
- LocationException(String, String, Object...) - Constructor for exception class uk.blankaspect.common.exception2.LocationException
-
Creates a new instance of an exception with the specified detail message and location.
- LocationException(String, Throwable, String, Object...) - Constructor for exception class uk.blankaspect.common.exception2.LocationException
-
Creates a new instance of an exception with the specified detail message, cause and location.
- LocationException(BaseException, String, Object...) - Constructor for exception class uk.blankaspect.common.exception2.LocationException
-
Creates a new instance of an exception from the detail message and cause of the specified exception and the specified location.
- locationToString(Path) - Static method in exception class uk.blankaspect.common.exception2.FileException
-
Returns a string representation of the specified location.
- LongNode - Class in uk.blankaspect.common.basictree
-
This class implements a node that contains a long integer.
- LongNode(long) - Constructor for class uk.blankaspect.common.basictree.LongNode
-
Creates a new instance of a 'long' node that has no parent and has the specified value.
- LongNode(AbstractNode, long) - Constructor for class uk.blankaspect.common.basictree.LongNode
-
Creates a new instance of a 'long' node that has the specified parent and value.
- longNodes() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node that are 'long' nodes.
- longStream() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a stream of the elements of this list node that are 'long' nodes.
M
- MapNode - Class in uk.blankaspect.common.basictree
- MapNode() - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has no parent and initially contains no key–value pairs.
- MapNode(Iterable<? extends MapNode.Pair>) - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has no parent and initially contains the specified key–value pairs.
- MapNode(Map<String, AbstractNode>) - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has no parent and initially contains the specified key–value pairs.
- MapNode(AbstractNode) - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has the specified parent and initially contains no key–value pairs.
- MapNode(AbstractNode, Iterable<? extends MapNode.Pair>) - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has the specified parent and initially contains the specified key–value pairs.
- MapNode(AbstractNode, Map<String, AbstractNode>) - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has the specified parent and initially contains the specified key–value pairs.
- MapNode(AbstractNode, MapNode.Pair...) - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has the specified parent and initially contains the specified key–value pairs.
- MapNode(MapNode.Pair...) - Constructor for class uk.blankaspect.common.basictree.MapNode
-
Creates a new instance of a map node that has no parent and initially contains the specified key–value pairs.
- MapNode.Pair - Class in uk.blankaspect.common.basictree
-
This class encapsulates a key–value pair of a map node.
- MapNodeKeyGenerator - Class in uk.blankaspect.common.basictree
-
This class implements a decorator for a map node that allows key–value pairs to be added to the map node with keys that are generated by a specified function.
- MapNodeKeyGenerator(MapNode) - Constructor for class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Creates a new instance of a generator of keys for the specified map node.
- mapNodes() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node that are map nodes.
- mapStream() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a stream of the elements of this list node that are map nodes.
- matches(Element) - Method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if the specified XML element matches this kind of JSON-XML element. - matches(Element, Iterable<ElementKind>) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if the specified XML element matches one of the specified kinds of JSON-XML element. - matches(Element, ElementKind...) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns
true
if the specified XML element matches one of the specified kinds of JSON-XML element. - maxLineLength(int) - Method in class uk.blankaspect.common.json.JsonGenerator.Builder
-
Sets the maximum length of a line of JSON text without wrapping.
- maxLineLength(int) - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml.Builder
-
Sets the maximum length of a line of JSON text without wrapping.
N
- NAMESPACE_NAME - Static variable in class uk.blankaspect.common.jsonxml.JsonXmlValidator
-
The name of the namespace in the XML Schema for JSON-XML that has a target namespace.
- NEVER - Enum constant in enum class uk.blankaspect.common.json.NewLineBeforeLeftBracket
-
Never write a new line (LF, U+000A) before the opening bracket of a JSON array or the opening brace of a JSON object.
- NEW_LINE - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
A line-feed character (U+000A).
- newLineBeforeLeftBracket(NewLineBeforeLeftBracket) - Method in class uk.blankaspect.common.json.JsonGenerator.Builder
-
Sets the circumstance in which a new line is written before the opening bracket of a JSON array or the opening brace of a JSON object.
- newLineBeforeLeftBracket(NewLineBeforeLeftBracket) - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml.Builder
-
Sets the circumstance in which a new line is written before the opening bracket of a JSON array or the opening brace of a JSON object.
- NewLineBeforeLeftBracket - Enum Class in uk.blankaspect.common.json
-
This is an enumeration of the circumstances in which a new line is written before the opening bracket of a JSON array or the opening brace of a JSON object.
- NODE - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Component
-
The node that is associated with the message.
- NODE_TYPES - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The types of nodes that represent JSON values.
- NodeMessage - Class in uk.blankaspect.common.basictree
-
This class encapsulates a message that relates to a node.
- NodeMessage(AbstractNode, NodeMessage.Kind, String) - Constructor for class uk.blankaspect.common.basictree.NodeMessage
-
Creates a new instance of a message of the specified kind that relates to the specified node.
- NodeMessage(AbstractNode, NodeMessage.Kind, String, Throwable) - Constructor for class uk.blankaspect.common.basictree.NodeMessage
-
Creates a new instance of a message of the specified kind that relates to the specified node.
- NodeMessage(AbstractNode, NodeMessage.Kind, Throwable) - Constructor for class uk.blankaspect.common.basictree.NodeMessage
-
Creates a new instance of a message of the specified kind that relates to the specified node.
- NodeMessage.Component - Enum Class in uk.blankaspect.common.basictree
-
This is an enumeration of the components of a node-related message.
- NodeMessage.Kind - Enum Class in uk.blankaspect.common.basictree
-
This is an enumeration of the kinds of a node-related message.
- NodeMessage.List - Class in uk.blankaspect.common.basictree
-
This class implements a list of node-related messages.
- nodesToArray(Collection<? extends BooleanNode>) - Static method in class uk.blankaspect.common.basictree.BooleanNode
-
Returns an array whose elements are the values of the specified Boolean nodes, with the order of the elements preserved.
- nodesToArray(Collection<? extends DoubleNode>) - Static method in class uk.blankaspect.common.basictree.DoubleNode
-
Returns an array whose elements are the values of the specified 'double' nodes, with the order of the elements preserved.
- nodesToArray(Collection<? extends IntNode>) - Static method in class uk.blankaspect.common.basictree.IntNode
-
Returns an array whose elements are the values of the specified 'int' nodes, with the order of the elements preserved.
- nodesToArray(Collection<? extends LongNode>) - Static method in class uk.blankaspect.common.basictree.LongNode
-
Returns an array whose elements are the values of the specified 'long' nodes, with the order of the elements preserved.
- nodesToArray(Collection<? extends StringNode>) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Returns an array whose elements are the values of the specified string nodes, with the order of the elements preserved.
- nodesToList(Iterable<? extends BooleanNode>) - Static method in class uk.blankaspect.common.basictree.BooleanNode
-
Returns a list whose elements are the values of the specified Boolean nodes, with the order of the elements preserved.
- nodesToList(Iterable<? extends DoubleNode>) - Static method in class uk.blankaspect.common.basictree.DoubleNode
-
Returns a list whose elements are the values of the specified 'double' nodes, with the order of the elements preserved.
- nodesToList(Iterable<? extends IntNode>) - Static method in class uk.blankaspect.common.basictree.IntNode
-
Returns a list whose elements are the values of the specified 'int' nodes, with the order of the elements preserved.
- nodesToList(Iterable<? extends LongNode>) - Static method in class uk.blankaspect.common.basictree.LongNode
-
Returns a list whose elements are the values of the specified 'long' nodes, with the order of the elements preserved.
- nodesToList(Iterable<? extends StringNode>) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Returns a list whose elements are the values of the specified string nodes, with the order of the elements preserved.
- nodeToPathString(AbstractNode) - Static method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns a string representation of the path from the specified node from the root of the tree to which it belongs.
- NodeType - Class in uk.blankaspect.common.basictree
-
This class represents the type of a node.
- NodeType(NodeType, Class<? extends AbstractNode>) - Constructor for class uk.blankaspect.common.basictree.NodeType
-
Creates a new node type that has the specified parent and is associated with the specified class of node.
- NodeTypeException - Exception Class in uk.blankaspect.common.basictree
-
This class implements an unchecked exception that is associated with a node type.
- NodeTypeException(NodeType) - Constructor for exception class uk.blankaspect.common.basictree.NodeTypeException
-
Creates a new instance of an exception that is associated with the specified node type.
- NONE - Enum constant in enum class uk.blankaspect.common.string.StringUtils.SplitMode
-
The separator is discarded after splitting.
- NORMAL - Enum constant in enum class uk.blankaspect.common.json.OutputMode
-
JSON text may be written on multiple lines with a space between some tokens.
- normaliseSpans() - Method in class uk.blankaspect.common.json.JsonText.Line
-
Combines adjacent spans that are associated with the same token.
- NULL - Enum constant in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Corresponds to a JSON null value.
- NULL_VALUE - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
A JSON null value.
- NullNode - Class in uk.blankaspect.common.basictree
-
This class implements a node that represents a null value.
- NullNode() - Constructor for class uk.blankaspect.common.basictree.NullNode
-
Creates a new instance of a null node that has no parent.
- NullNode(AbstractNode) - Constructor for class uk.blankaspect.common.basictree.NullNode
-
Creates a new instance of a null node that has the specified parent.
- NUMBER - Enum constant in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Corresponds to a JSON number.
- NUMBER_TYPES - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The types of nodes that represent JSON numbers.
- NUMBER_VALUE - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
A JSON number value.
- numSpans() - Method in class uk.blankaspect.common.json.JsonText.Line
-
Returns the number of spans of text that are associated with this line.
- numSpans() - Method in interface uk.blankaspect.common.text.ITextLine
-
Returns the number of spans of text that are associated with this line.
O
- OBJECT - Enum constant in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Corresponds to a JSON object.
- OBJECT_DELIMITER - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
The start or end delimiter of a JSON object.
- OBJECT_END_CHAR - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The character that denotes the end of a JSON object.
- OBJECT_MEMBER_NAME - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
The name of a member of a JSON object.
- OBJECT_MEMBER_SEPARATOR_CHAR - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The character that separates adjacent members of a JSON object.
- OBJECT_NAME_VALUE_SEPARATOR - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
The separator between the name and value of a member of a JSON object.
- OBJECT_NAME_VALUE_SEPARATOR_CHAR - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The character that separates the name and value of a member of a JSON object.
- OBJECT_START_CHAR - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The character that denotes the start of a JSON object.
- of(String) - Static method in exception class uk.blankaspect.common.jsonxml.ElementKind.UnexpectedKindException
-
Creates and returns a new instance of
UnexpectedKindException
whose detail message includes the specified name of an element of an unexpected kind. - of(Element) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns the kind of JSON-XML element of the specified XML element.
- offset() - Method in class uk.blankaspect.common.json.JsonText.Line
-
Returns the offset from the start of the text to the start of this line.
- offset() - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Returns the offset from the start of the text to the start of this span.
- offset() - Method in interface uk.blankaspect.common.text.ITextLine
-
Returns the offset from the start of the text to the start of this line.
- offset() - Method in interface uk.blankaspect.common.text.ITextSpan
-
Returns the offset from the start of the text to the start of this span.
- OFFSET_COMPARATOR - Static variable in interface uk.blankaspect.common.text.ITextLine
-
A comparator that compares two lines by the offset from the start of the text to the start of the line.
- OFFSET_COMPARATOR - Static variable in interface uk.blankaspect.common.text.ITextSpan
-
A comparator that compares two spans by the offset from the start of the text to the start of the span.
- OFFSET_LENGTH_COMPARATOR - Static variable in interface uk.blankaspect.common.text.ITextSpan
-
A comparator that compares two spans: first, by the offset from the start of the text to the start of the span; then, if the offsets are equal, by the length of the span.
- ofThrow(Element) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns the kind of JSON-XML element of the specified XML element.
- outputMode(OutputMode) - Method in class uk.blankaspect.common.json.JsonGenerator.Builder
-
Sets the way in which whitespace is written between the tokens of the JSON text.
- outputMode(OutputMode) - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml.Builder
-
Sets the way in which whitespace is written between the tokens of the JSON text.
- OutputMode - Enum Class in uk.blankaspect.common.json
-
This is an enumeration of the ways in which a JSON generator can write whitespace between the tokens of the JSON text.
P
- padAfter(CharSequence, int) - Static method in class uk.blankaspect.common.string.StringUtils
- padAfter(CharSequence, int, char) - Static method in class uk.blankaspect.common.string.StringUtils
- padBefore(CharSequence, int) - Static method in class uk.blankaspect.common.string.StringUtils
- padBefore(CharSequence, int, char) - Static method in class uk.blankaspect.common.string.StringUtils
- pair(String, boolean) - Static method in class uk.blankaspect.common.basictree.MapNode
-
Creates a Boolean node for the specified value, creates a key–value pair whose key is the specified key and whose value is the Boolean node, and returns the KV pair.
- pair(String, double) - Static method in class uk.blankaspect.common.basictree.MapNode
-
Creates a 'double' node for the specified value, creates a key–value pair whose key is the specified key and whose value is the 'double' node, and returns the KV pair.
- pair(String, int) - Static method in class uk.blankaspect.common.basictree.MapNode
-
Creates an 'int' node for the specified value, creates a key–value pair whose key is the specified key and whose value is the 'int' node, and returns the KV pair.
- pair(String, long) - Static method in class uk.blankaspect.common.basictree.MapNode
-
Creates a 'long' node for the specified value, creates a key–value pair whose key is the specified key and whose value is the 'long' node, and returns the KV pair.
- pair(String, String) - Static method in class uk.blankaspect.common.basictree.MapNode
-
Creates a string node for the specified value, creates a key–value pair whose key is the specified key and whose value is the string node, and returns the KV pair.
- Pair(String, AbstractNode) - Constructor for class uk.blankaspect.common.basictree.MapNode.Pair
-
Creates a new instance of a key–value pair of a map node.
- PAIR_SEPARATOR_CHAR - Static variable in class uk.blankaspect.common.basictree.MapNode
-
The character that separates adjacent KV pairs in the string representation of a map node.
- parent(Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Returns the parent of the specified element, which is assumed to be an element.
- parse(InputStream) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the text that is composed of characters that are read from the specified byte stream using the UTF-8 character encoding.
- parse(InputStream, Charset) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the text that is composed of characters that are read from the specified byte stream using the specified character encoding.
- parse(Reader) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the text that is read from a character stream by the specified reader.
- parse(CharSequence) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the specified text.
- parseToXml(InputStream) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the text that is composed of characters that are read from the specified byte stream using the UTF-8 character encoding.
- parseToXml(InputStream, Charset) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the text that is composed of characters that are read from the specified byte stream using the specified character encoding.
- parseToXml(Reader) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the text that is read from a character stream by the specified reader.
- parseToXml(CharSequence) - Method in class uk.blankaspect.common.json.JsonParser
-
Parses the specified text.
- PathUtils - Class in uk.blankaspect.common.filesystem
-
This class contains utility methods that relate to file-system locations.
- PREFIX - Enum constant in enum class uk.blankaspect.common.string.StringUtils.SplitMode
-
The separator is the last character of the prefix after splitting.
- printableAsciiOnly(boolean) - Method in class uk.blankaspect.common.json.JsonGenerator.Builder
-
Sets the flag that determines whether JSON string values and the names of the members of JSON objects will be escaped so that they contain only printable characters from the US-ASCII character encoding (ie, characters in the range U+0020 to U+007E inclusive).
- printableAsciiOnly(boolean) - Method in class uk.blankaspect.common.jsonxml.JsonGeneratorXml.Builder
-
Sets the flag that determines whether JSON string values and the names of the members of JSON objects will be escaped so that they contain only printable characters from the US-ASCII character encoding (ie, characters in the range U+0020 to U+007E inclusive).
R
- readFile(Path) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Opens a character stream on the specified file, which is expected to contain text with the UTF-8 character encoding, parses the character stream as JSON text and returns the resulting JSON value.
- remove(Iterable<String>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Removes the key–value pairs with the specified keys from this map node.
- remove(String...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Removes the key–value pairs with the specified keys from this map node.
- remove(Predicate<String>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Removes from this map node the key–value pairs whose keys are accepted by the specified filter.
- removePrefix(String, String) - Static method in class uk.blankaspect.common.string.StringUtils
- removeSuffix(String, String) - Static method in class uk.blankaspect.common.string.StringUtils
- retain(String...) - Method in class uk.blankaspect.common.basictree.MapNode
-
Removes all key–value pairs from this map node except for those with the specified keys.
- retain(Collection<String>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Removes all key–value pairs from this map node except for those with the specified keys.
- retain(Predicate<String>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Removes all key–value pairs from this map node except for those whose keys are accepted by the specified filter.
S
- searchAscending(T, Function<T, T>, Predicate<T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Ascends a tree from the specified start node to the root node, applying the specified test to each node that is visited until a node is found that satisfies the test.
- searchAscending(T, Predicate<T>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Ascends a tree of
ITreeNode
s from the specified start node to the root node, applying the specified test to each node that is visited until a node is found that satisfies the test. - searchAscending(T, T, boolean, Function<T, T>, Predicate<T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Ascends a tree from the specified start node to the specified end node, applying the specified test to each node that is visited until a node is found that satisfies the test.
- searchAscending(T, T, boolean, Predicate<T>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Ascends a tree of
ITreeNode
s from the specified start node to the specified end node, applying the specified test to each node that is visited until a node is found that satisfies the test. - searchBreadthFirst(T, boolean, Function<T, List<T>>, Predicate<T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Performs a breadth-first search of a tree, starting from the specified root node and applying the specified test to each node that is visited until a node is found that satisfies the test.
- searchBreadthFirst(T, boolean, Predicate<T>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Performs a breadth-first search of a tree of
ITreeNode
s, starting from the specified root node and applying the specified test to each node that is visited until a node is found that satisfies the test. - searchDepthFirst(T, boolean, boolean, Function<T, List<T>>, Predicate<T>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Performs a depth-first search of a tree, starting from the specified root node and applying the specified test to each node that is visited until a node is found that satisfies the test.
- searchDepthFirst(T, boolean, boolean, Predicate<T>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Performs a depth-first search of a tree of
ITreeNode
s, starting from the specified root node and applying the specified test to each node that is visited until a node is found that satisfies the test. - setAttribute(Element, String, String) - Method in interface uk.blankaspect.common.jsonxml.IElementFacade
-
Sets the value of a named attribute of the specified element.
- setAttribute(Element, String, String) - Method in class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Sets the value of a named attribute of the specified element.
- setElements(Iterable<? extends AbstractNode>) - Method in class uk.blankaspect.common.basictree.ListNode
-
Sets the elements of this list node to the specified nodes.
- setElements(AbstractNode...) - Method in class uk.blankaspect.common.basictree.ListNode
-
Sets the elements of this list node to the specified nodes.
- setKeyConverter(Function<CharSequence, String>) - Static method in class uk.blankaspect.common.basictree.MapNode.Pair
-
Sets the function that converts the key of a key–value pair to its string representation for the
MapNode.Pair.toString()
method. - setKeyGenerator(Function<MapNode, String>) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Sets the function that is used to generate keys for the associated map node.
- setKeyIndex(int) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Sets the next value of the auto-incrementing index that is used by the default key-generator function.
- setKeyPrefix(String) - Method in class uk.blankaspect.common.basictree.MapNodeKeyGenerator
-
Sets the prefix of the keys that are generated by the default key-generator function.
- setName(Element, String) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Sets the value of the name attribute of the specified XML element, which corresponds to the name of a member of a JSON object.
- setName(IElementFacade, Element, String) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Sets the value of the name attribute of the specified XML element, which corresponds to the name of a member of a JSON object.
- setPairs(Map<String, AbstractNode>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Sets the key–value pairs of this map node to the specified pairs of keys and values.
- setParent(AbstractNode) - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Sets the parent of this node to the specified node.
- setValue(Element, String) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Sets the value of the value attribute of the specified XML element, which corresponds to a JSON value.
- setValue(IElementFacade, Element, String) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Sets the value of the value attribute of the specified XML element, which corresponds to a JSON value.
- SIMPLE_KINDS - Static variable in enum class uk.blankaspect.common.jsonxml.ElementKind
-
The kinds of element that correspond to simple JSON values.
- SIMPLE_NODE_TYPES - Static variable in interface uk.blankaspect.common.json.JsonConstants
-
The types of nodes that represent simple JSON values.
- SimpleElementFacade - Class in uk.blankaspect.common.jsonxml
-
This class provides methods that can be used to create JSON-XML elements and to access the attributes of JSON-XML elements.
- SimpleElementFacade(String) - Constructor for class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Creates a new instance of a facade that provides methods for creating a JSON-XML element and accessing the attributes of a JSON-XML element.
- SimpleElementFacade(String, String, String) - Constructor for class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Creates a new instance of a facade that provides methods for creating a JSON-XML element and accessing the attributes of a JSON-XML element.
- SimpleElementFacade(String, String, Document) - Constructor for class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Creates a new instance of a facade that provides methods for creating a JSON-XML element and accessing the attributes of a JSON-XML element.
- SimpleElementFacade(Document) - Constructor for class uk.blankaspect.common.jsonxml.SimpleElementFacade
-
Creates a new instance of a facade that provides methods for creating a JSON-XML element and accessing the attributes of a JSON-XML element.
- sort() - Method in class uk.blankaspect.common.basictree.MapNode
-
Sorts the key–value pairs of this map node into ascending order of their keys by applying the
String.compareTo(String)
method to the keys. - sort(Comparator<String>) - Method in class uk.blankaspect.common.basictree.MapNode
-
Sorts the key–value pairs of this map node by applying the specified comparator to their keys.
- SPACE - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
A sequence of space characters (U+0020).
- Span(JsonText.Line, int, JsonText.Token) - Constructor for record class uk.blankaspect.common.json.JsonText.Span
-
Creates an instance of a
Span
record class. - spans() - Method in class uk.blankaspect.common.json.JsonText.Line
-
Returns a list of the spans of text that are associated with this line.
- spans() - Method in interface uk.blankaspect.common.text.ITextLine
-
Returns a list of the spans of text that are associated with this line.
- split(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- split(String, char, boolean) - Static method in class uk.blankaspect.common.string.StringUtils
- splitAt(String, int, StringUtils.SplitMode) - Static method in class uk.blankaspect.common.string.StringUtils
- splitAtFirst(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- splitAtFirst(String, char, StringUtils.SplitMode) - Static method in class uk.blankaspect.common.string.StringUtils
- splitAtLast(String, char) - Static method in class uk.blankaspect.common.string.StringUtils
- splitAtLast(String, char, StringUtils.SplitMode) - Static method in class uk.blankaspect.common.string.StringUtils
- START_CHAR - Static variable in class uk.blankaspect.common.basictree.ListNode
-
The character that denotes the start of the string representation of a list node.
- START_CHAR - Static variable in class uk.blankaspect.common.basictree.MapNode
-
The character that denotes the start of the string representation of a map node.
- START_CHAR - Static variable in class uk.blankaspect.common.basictree.StringNode
-
The character that denotes the start of the string representation of a string node.
- storeExcessiveIntegerAsFP(boolean) - Method in class uk.blankaspect.common.json.JsonParser.Builder
-
Sets or clears the flag that determines whether a JSON number that is deemed to be an integer but is too large to be stored as a signed 64-bit integer (ie, a
long
) will be stored as a double-precision floating-point number (ie, adouble
). - STRING - Enum constant in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Corresponds to a JSON string.
- STRING_VALUE - Enum constant in enum class uk.blankaspect.common.json.JsonText.Token
-
A JSON string value.
- StringNode - Class in uk.blankaspect.common.basictree
-
This class implements a node that contains a string.
- StringNode(String) - Constructor for class uk.blankaspect.common.basictree.StringNode
-
Creates a new instance of a string node that has no parent and has the specified value.
- StringNode(AbstractNode, String) - Constructor for class uk.blankaspect.common.basictree.StringNode
-
Creates a new instance of a string node that has the specified parent and value.
- stringNodes() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a list of the elements of this list node that are string nodes.
- stringStream() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a stream of the elements of this list node that are string nodes.
- StringUtils - Class in uk.blankaspect.common.string
-
This class contains utility methods that relate to strings and character sequences.
- StringUtils.SplitMode - Enum Class in uk.blankaspect.common.string
-
This is an enumeration of the ways in which an input string may be split by the
split*(…)
methods. - stripAfter(CharSequence) - Static method in class uk.blankaspect.common.string.StringUtils
- stripBefore(CharSequence) - Static method in class uk.blankaspect.common.string.StringUtils
- SUFFIX - Enum constant in enum class uk.blankaspect.common.string.StringUtils.SplitMode
-
The separator is the first character of the suffix after splitting.
T
- tempLocation(Path) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Returns a temporary file-system location that has the same parent directory as the specified location.
- TEMPORARY_FILENAME_EXTENSION - Static variable in class uk.blankaspect.common.json.JsonUtils
-
The filename extension of a temporary file.
- testAscending(T, Predicate<T>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns
true
if and only if the specifiedITreeNode
or one of its ancestors satisfies the specified test. - text() - Method in class uk.blankaspect.common.json.JsonText.Line
-
Returns the text of this line.
- text() - Method in interface uk.blankaspect.common.text.ITextLine
-
Returns the text of this line.
- TEXT - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Component
-
The text of the message.
- throwCause(Throwable) - Static method in exception class uk.blankaspect.common.exception2.BaseException
-
Tests the cause of the specified exception, and throws the causal exception if it is a
BaseException
. - throwCause(Throwable) - Static method in exception class uk.blankaspect.common.exception2.FileException
-
Tests the cause of the specified exception, and throws the causal exception if it is a
FileException
. - throwCause(Throwable, boolean) - Static method in exception class uk.blankaspect.common.exception2.BaseException
-
Tests the cause of the specified exception, or, optionally, searches the causal chain of the specified exception, and, if a
BaseException
is found, throws it. - throwCause(Throwable, boolean) - Static method in exception class uk.blankaspect.common.exception2.FileException
-
Tests the cause of the specified exception, or, optionally, searches the causal chain of the specified exception, and, if a
FileException
is found, throws it. - toCamelCase(CharSequence) - Static method in class uk.blankaspect.common.string.StringUtils
-
Converts the specified text to camel case and returns the resulting string.
- toJsonText(Element, boolean) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Converts the tree of JSON-XML elements whose root is the specified XML element to JSON text and returns the text.
- toJsonText(IElementFacade, Element, boolean) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Converts the tree of JSON-XML elements whose root is the specified XML element to JSON text and returns the text.
- token() - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Returns the value of the
token
record component. - toString() - Method in class uk.blankaspect.common.basictree.BooleanNode
-
Returns a string representation of this Boolean node.
- toString() - Method in class uk.blankaspect.common.basictree.DoubleNode
-
Returns a string representation of this 'double' node.
- toString() - Method in class uk.blankaspect.common.basictree.IntNode
-
Returns a string representation of this 'int' node.
- toString() - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a string representation of this list node.
- toString() - Method in class uk.blankaspect.common.basictree.LongNode
-
Returns a string representation of this 'long' node.
- toString() - Method in class uk.blankaspect.common.basictree.MapNode.Pair
-
Returns a string representation of this pair.
- toString() - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns a string representation of this map node.
- toString() - Method in class uk.blankaspect.common.basictree.NodeMessage
- toString() - Method in class uk.blankaspect.common.basictree.NodeType
-
Returns a string representation of this node type, which is the name of the class of node with which this node type is associated.
- toString() - Method in class uk.blankaspect.common.basictree.NullNode
-
Returns a string representation of this null node.
- toString() - Method in class uk.blankaspect.common.basictree.StringNode
-
Returns a string representation of this string node.
- toString() - Method in class uk.blankaspect.common.json.JsonText.Line
- toString() - Method in record class uk.blankaspect.common.json.JsonText.Span
-
Returns a string representation of this record class.
- toString() - Method in class uk.blankaspect.common.json.JsonText
- toString() - Method in exception class uk.blankaspect.common.jsonxml.JsonGeneratorXml.UnrecognisedElementException
- toString(boolean) - Method in class uk.blankaspect.common.basictree.AbstractNode
-
Returns a string representation of this node whose characters may optionally be escaped where necessary so that the returned string contains only printable characters from the US-ASCII character encoding.
- toString(boolean) - Method in class uk.blankaspect.common.basictree.ListNode
-
Returns a string representation of this node whose characters may optionally be escaped where necessary so that the returned string contains only printable characters from the US-ASCII character encoding.
- toString(boolean) - Method in class uk.blankaspect.common.basictree.MapNode
-
Returns a string representation of this node whose characters may optionally be escaped where necessary so that the returned string contains only printable characters from the US-ASCII character encoding.
- toString(boolean) - Method in class uk.blankaspect.common.basictree.StringNode
-
Returns a string representation of this node whose characters may optionally be escaped where necessary so that the returned string contains only printable characters from the US-ASCII character encoding.
- toString(String, Iterable<NodeMessage.Component>) - Method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns a string representation of the specified components of this message.
- toString(String, NodeMessage.Component...) - Method in class uk.blankaspect.common.basictree.NodeMessage
-
Returns a string representation of the specified components of this message.
- toXmlText(Element, int, int) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Generates a textual representation of the tree of JSON-XML elements whose root is the specified XML element and returns the text.
- treeToString(T, int, Function<T, String>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Returns a string representation of the tree of
ITreeNode
s whose root is the specified node. - treeToString(T, int, Function<T, T>, Function<T, List<T>>, Function<T, String>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Returns a string representation of the tree whose root is the specified node.
- TreeTraversal - Class in uk.blankaspect.common.treetraversal
-
This class contains utility methods that relate to the traversal of a tree.
- TreeUtils - Class in uk.blankaspect.common.tree
-
This class contains utility methods that relate to trees whose nodes implement the
ITreeNode
interface. - TYPE - Static variable in class uk.blankaspect.common.basictree.BooleanNode
-
The type of a Boolean node.
- TYPE - Static variable in class uk.blankaspect.common.basictree.DoubleNode
-
The type of a 'double' node.
- TYPE - Static variable in class uk.blankaspect.common.basictree.IntNode
-
The type of an 'int' node.
- TYPE - Static variable in class uk.blankaspect.common.basictree.ListNode
-
The type of a list node.
- TYPE - Static variable in class uk.blankaspect.common.basictree.LongNode
-
The type of a 'long' node.
- TYPE - Static variable in class uk.blankaspect.common.basictree.MapNode
-
The type of a map node.
- TYPE - Static variable in class uk.blankaspect.common.basictree.NullNode
-
The type of a null node.
- TYPE - Static variable in class uk.blankaspect.common.basictree.StringNode
-
The type of a string node.
U
- uk.blankaspect.common.basictree - package uk.blankaspect.common.basictree
-
This package contains an abstract base class and concrete subclasses that implement a node that represents a null value, nodes that contain instances of fundamental Java types (
boolean
,int
,long
,double
andString
), and nodes that contain other nodes (a list and a map). - uk.blankaspect.common.exception2 - package uk.blankaspect.common.exception2
- uk.blankaspect.common.filesystem - package uk.blankaspect.common.filesystem
- uk.blankaspect.common.json - package uk.blankaspect.common.json
-
This package provides a parser and a generator for JavaScript Object Notation (JSON).
- uk.blankaspect.common.jsonxml - package uk.blankaspect.common.jsonxml
- uk.blankaspect.common.string - package uk.blankaspect.common.string
- uk.blankaspect.common.text - package uk.blankaspect.common.text
- uk.blankaspect.common.tree - package uk.blankaspect.common.tree
- uk.blankaspect.common.treetraversal - package uk.blankaspect.common.treetraversal
- UNDEFINED - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
The kind of message is not defined.
- UnexpectedKindException() - Constructor for exception class uk.blankaspect.common.jsonxml.ElementKind.UnexpectedKindException
-
Creates a new instance of an exception with no detail message.
- UnexpectedKindException(String) - Constructor for exception class uk.blankaspect.common.jsonxml.ElementKind.UnexpectedKindException
-
Creates a new instance of an exception with the specified detail message.
- UNICODE_ESCAPE_CHAR - Static variable in class uk.blankaspect.common.basictree.StringNode
-
The character that denotes a Unicode escape sequence when it follows the escape prefix.
- unicodeEscape(char) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Returns the Unicode escape sequence of the specified character.
- UnrecognisedElementException(Element) - Constructor for exception class uk.blankaspect.common.jsonxml.JsonGeneratorXml.UnrecognisedElementException
-
Creates a new instance of an exception that is associated with the specified unrecognised XML element.
V
- validate(Class<?>, String, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlValidator
-
Validates a tree of JSON-XML elements whose root is the specified element against an XML Schema (XSD) that is created from a resource at the specified location.
- validate(Path, Element) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlValidator
-
Validates a tree of JSON-XML elements whose root is the specified element against an XML Schema (XSD) that is created from a file at the specified file-system location.
- validate(Element, boolean) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlValidator
-
Validates a tree of JSON-XML elements whose root is the specified element against one of two predefined XML Schemas (XSD) according to the specified flag.
- VALUE - Static variable in class uk.blankaspect.common.basictree.NullNode
-
The string representation of a null node.
- VALUE_FALSE - Static variable in class uk.blankaspect.common.basictree.BooleanNode
-
The string representation of a Boolean node whose value is false.
- VALUE_TRUE - Static variable in class uk.blankaspect.common.basictree.BooleanNode
-
The string representation of a Boolean node whose value is true.
- valueOf(String) - Static method in enum class uk.blankaspect.common.basictree.NodeMessage.Component
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.blankaspect.common.json.JsonText.Token
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.blankaspect.common.json.NewLineBeforeLeftBracket
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.blankaspect.common.json.OutputMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class uk.blankaspect.common.string.StringUtils.SplitMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class uk.blankaspect.common.basictree.NodeMessage.Component
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.blankaspect.common.json.JsonText.Token
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.blankaspect.common.json.NewLineBeforeLeftBracket
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.blankaspect.common.json.OutputMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.blankaspect.common.jsonxml.ElementKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class uk.blankaspect.common.string.StringUtils.SplitMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- valuesToNodes(boolean...) - Static method in class uk.blankaspect.common.basictree.BooleanNode
-
Creates a list of Boolean nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(double...) - Static method in class uk.blankaspect.common.basictree.DoubleNode
-
Creates a list of 'double' nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(int...) - Static method in class uk.blankaspect.common.basictree.IntNode
-
Creates a list of 'int' nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(long...) - Static method in class uk.blankaspect.common.basictree.LongNode
-
Creates a list of 'long' nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(Iterable<Boolean>) - Static method in class uk.blankaspect.common.basictree.BooleanNode
-
Creates a list of Boolean nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(Iterable<Double>) - Static method in class uk.blankaspect.common.basictree.DoubleNode
-
Creates a list of 'double' nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(Iterable<Integer>) - Static method in class uk.blankaspect.common.basictree.IntNode
-
Creates a list of 'int' nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(Iterable<Long>) - Static method in class uk.blankaspect.common.basictree.LongNode
-
Creates a list of 'long' nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(Iterable<String>) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Creates a list of string nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- valuesToNodes(String...) - Static method in class uk.blankaspect.common.basictree.StringNode
-
Creates a list of string nodes for the specified values, preserving the order of the elements, and returns the list, which may be used to construct a list node.
- visitAscending(T, Function<T, Boolean>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Ascends a tree of
ITreeNode
s from the specified node to the root node, applying the specified action to each node that is visited, including the root. - visitAscending(T, Function<T, T>, Function<T, Boolean>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Ascends a tree from the specified node to the root node, applying the specified action to each node that is visited, including the root.
- visitAscending(T, T, boolean, Function<T, Boolean>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Ascends a tree of
ITreeNode
s from the specified node to the specified end node, applying the specified action to each node that is visited. - visitAscending(T, T, boolean, Function<T, T>, Function<T, Boolean>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Ascends a tree from the specified node to the specified end node, applying the specified action to each node that is visited.
- visitBreadthFirst(T, boolean, Function<T, Boolean>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Performs a breadth-first traversal of a tree of
ITreeNode
s, starting from the specified root node and applying the specified action to each node that is visited. - visitBreadthFirst(T, boolean, Function<T, List<T>>, Function<T, Boolean>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Performs a breadth-first traversal of a tree, starting from the specified root node and applying the specified action to each node that is visited.
- visitDepthFirst(T, boolean, boolean, Function<T, Boolean>) - Static method in class uk.blankaspect.common.tree.TreeUtils
-
Performs a depth-first traversal of a tree of
ITreeNode
s, starting from the specified root node and applying the specified action to each node that is visited. - visitDepthFirst(T, boolean, boolean, Function<T, List<T>>, Function<T, Boolean>) - Static method in class uk.blankaspect.common.treetraversal.TreeTraversal
-
Performs a depth-first traversal of a tree, starting from the specified root node and applying the specified action to each node that is visited.
W
- WARNING - Enum constant in enum class uk.blankaspect.common.basictree.NodeMessage.Kind
-
A warning message.
- wrap(CharSequence, int) - Static method in class uk.blankaspect.common.string.StringUtils
- wrapLines(CharSequence, int) - Static method in class uk.blankaspect.common.string.StringUtils
- writeFile(Path, AbstractNode) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Writes the specified JSON value to the specified file as JSON text.
- writeFile(Path, AbstractNode, JsonGenerator) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Writes the specified JSON value to the specified file as JSON text that is generated by the specified instance of
JsonGenerator
. - writeJson(Element, boolean, Writer) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Converts the tree of JSON-XML elements whose root is the specified XML element to JSON text and writes the text to the specified character stream.
- writeJson(IElementFacade, Element, boolean, Writer) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Converts the tree of JSON-XML elements whose root is the specified XML element to JSON text and writes the text to the specified character stream.
- writeText(Path, String) - Static method in class uk.blankaspect.common.json.JsonUtils
-
Writes the specified text to the specified file with the UTF-8 character encoding.
- writeXml(Element, int, int, Writer) - Static method in class uk.blankaspect.common.jsonxml.JsonXmlUtils
-
Generates a textual representation of the tree of JSON-XML elements whose root is the specified XML element and writes the text to the specified character stream.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
JsonUtils.isCompoundJsonValue(uk.blankaspect.common.basictree.AbstractNode)
and will eventually be removed.