Index (json-flattener 0.16.4 API)

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

A

ALL - Enum constant in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Escapes all JSON special characters and Unicode.
ALL_BUT_SLASH - Enum constant in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Escapes all JSON special characters and Unicode but slash('/').
ALL_BUT_SLASH_AND_UNICODE - Enum constant in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Escapes all JSON special characters but slash('/') and Unicode.
ALL_BUT_UNICODE - Enum constant in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Escapes all JSON special characters but Unicode.
ALL_UNICODES - Enum constant in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Deprecated.
for removal in 0.17.0 in favor of StringEscapePolicy.ALL

B

build(JsonValueBase<?>) - Method in class com.github.wnameless.json.flattener.JsonFlattenerFactory: Creates a JsonFlattener by given JsonValueBase and configures it with the configurer and jsonCore within this JsonFlattenerFactory.
build(Reader) - Method in class com.github.wnameless.json.flattener.JsonFlattenerFactory: Creates a JsonFlattener by given JSON reader and configures it with the configurer and jsonCore within this JsonFlattenerFactory.
build(Reader) - Method in class com.github.wnameless.json.unflattener.JsonUnflattenerFactory: Creates a JsonUnflattener by given JSON reader and configures it with the configurer and jsonCore within this JsonUnflattenerFactory.
build(String) - Method in class com.github.wnameless.json.flattener.JsonFlattenerFactory: Creates a JsonFlattener by given JSON string and configures it with the configurer and jsonCore within this JsonFlattenerFactory.
build(String) - Method in class com.github.wnameless.json.unflattener.JsonUnflattenerFactory: Creates a JsonUnflattener by given JSON string and configures it with the configurer and jsonCore within this JsonUnflattenerFactory.
build(Map<String, ?>) - Method in class com.github.wnameless.json.unflattener.JsonUnflattenerFactory: Creates a JsonUnflattener by given flattened Map and configures it with the configurer and jsonCore within this JsonUnflattenerFactory.

C

CharSequenceTranslatorFactory - Interface in com.github.wnameless.json.flattener: CharSequenceTranslatorFactory is designed to enhance the StringEscapePolicy.
Any method which accepts a StringEscapePolicy (eg: JsonFlattener#withStringEscapePolicy) now accepts CharSequenceTranslatorFactory as well.

Furthermore, anyone can provide their own StringEscapePolicy by implementing a CharSequenceTranslatorFactory.
com.github.wnameless.json.flattener - module com.github.wnameless.json.flattener
com.github.wnameless.json.flattener - package com.github.wnameless.json.flattener
com.github.wnameless.json.unflattener - package com.github.wnameless.json.unflattener

D

DEFAULT - Enum constant in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Escapes all JSON special characters but slash('/') and Unicode.

E

equals(Object) - Method in class com.github.wnameless.json.flattener.JsonFlattener
equals(Object) - Method in class com.github.wnameless.json.flattener.JsonFlattenerFactory
equals(Object) - Method in class com.github.wnameless.json.unflattener.JsonUnflattener
equals(Object) - Method in class com.github.wnameless.json.unflattener.JsonUnflattenerFactory

F

flatten() - Method in class com.github.wnameless.json.flattener.JsonFlattener: Returns a flattened JSON string.
flatten(JsonValueBase<?>) - Static method in class com.github.wnameless.json.flattener.JsonFlattener: Returns a flattened JSON string.
flatten(String) - Static method in class com.github.wnameless.json.flattener.JsonFlattener: Returns a flattened JSON string.
flattenAsMap() - Method in class com.github.wnameless.json.flattener.JsonFlattener: Returns a flattened JSON as Map.
flattenAsMap(JsonValueBase<?>) - Static method in class com.github.wnameless.json.flattener.JsonFlattener: Returns a flattened JSON as Map.
flattenAsMap(String) - Static method in class com.github.wnameless.json.flattener.JsonFlattener: Returns a flattened JSON as Map.
FlattenMode - Enum Class in com.github.wnameless.json.flattener: FlattenMode lists all acceptable modes of the JsonFlattener.

G

getCharSequenceTranslator() - Method in interface com.github.wnameless.json.flattener.CharSequenceTranslatorFactory: Returns a CharSequenceTranslator
getCharSequenceTranslator() - Method in enum class com.github.wnameless.json.flattener.StringEscapePolicy
getCurrent() - Method in class com.github.wnameless.json.flattener.IndexedPeekIterator: Returns the last returned element.
getIndex() - Method in class com.github.wnameless.json.flattener.IndexedPeekIterator: Returns the index of last returned element.

H

hashCode() - Method in class com.github.wnameless.json.flattener.JsonFlattener
hashCode() - Method in class com.github.wnameless.json.flattener.JsonFlattenerFactory
hashCode() - Method in class com.github.wnameless.json.unflattener.JsonUnflattener
hashCode() - Method in class com.github.wnameless.json.unflattener.JsonUnflattenerFactory
hasNext() - Method in class com.github.wnameless.json.flattener.IndexedPeekIterator

I

ignoreReservedCharacters() - Method in class com.github.wnameless.json.flattener.JsonFlattener: After this option is enable, all reserved characters used in keys will stop to be checked and escaped.
IndexedPeekIterator<E> - Class in com.github.wnameless.json.flattener: IndexedPeekIterator is an Iterator which provides user a peek() method to peek an element advanced, a getIndex() method to get the index of last returned element and a getCurrent() method to get the last returned element itself.
IndexedPeekIterator(Iterator<? extends E>) - Constructor for class com.github.wnameless.json.flattener.IndexedPeekIterator: Creates an IndexedPeekIterator.

J

JsonFlattener - Class in com.github.wnameless.json.flattener: JsonFlattener flattens any JSON nested objects or arrays into a flattened JSON string or a Map<Stirng, Object>.
JsonFlattener(JsonCore<?>, JsonValueBase<?>) - Constructor for class com.github.wnameless.json.flattener.JsonFlattener: Creates a JSON flattener by given JsonCore and JsonValueBase.
JsonFlattener(JsonCore<?>, Reader) - Constructor for class com.github.wnameless.json.flattener.JsonFlattener: Creates a JSON flattener by given JsonCore and JSON string reader.
JsonFlattener(JsonCore<?>, String) - Constructor for class com.github.wnameless.json.flattener.JsonFlattener: Creates a JSON flattener by given JsonCore and JSON string.
JsonFlattener(JsonValueBase<?>) - Constructor for class com.github.wnameless.json.flattener.JsonFlattener: Creates a JSON flattener by given JsonValueBase.
JsonFlattener(Reader) - Constructor for class com.github.wnameless.json.flattener.JsonFlattener: Creates a JSON flattener by given JSON string reader.
JsonFlattener(String) - Constructor for class com.github.wnameless.json.flattener.JsonFlattener: Creates a JSON flattener by given JSON string.
JsonFlattenerFactory - Class in com.github.wnameless.json.flattener: JsonFlattenerFactory preserves the configuration of a JsonFlattener, in doing so, any input JSON data can be used to create a JsonFlattener object with the same configuration.
JsonFlattenerFactory(Consumer<JsonFlattener>) - Constructor for class com.github.wnameless.json.flattener.JsonFlattenerFactory: Returns a JsonFlattenerFactory.
JsonFlattenerFactory(Consumer<JsonFlattener>, JsonCore<?>) - Constructor for class com.github.wnameless.json.flattener.JsonFlattenerFactory: Returns a JsonFlattenerFactory.
JsonifyArrayList<E> - Class in com.github.wnameless.json.flattener: JsonifyArrayList is simply a ArrayList but with an override jsonify toString method.
JsonifyArrayList() - Constructor for class com.github.wnameless.json.flattener.JsonifyArrayList
JsonifyArrayList(Collection<E>) - Constructor for class com.github.wnameless.json.flattener.JsonifyArrayList
JsonifyLinkedHashMap<K,V> - Class in com.github.wnameless.json.flattener: JsonifyLinkedHashMap is simple a LinkedHashMap but with an override jsonify toString method.
JsonifyLinkedHashMap() - Constructor for class com.github.wnameless.json.flattener.JsonifyLinkedHashMap
JsonifyLinkedHashMap(Map<K, V>) - Constructor for class com.github.wnameless.json.flattener.JsonifyLinkedHashMap
JsonUnflattener - Class in com.github.wnameless.json.unflattener: JsonUnflattener provides a static JsonUnflattener.unflatten(String) method to unflatten any flattened JSON string back to nested one.
JsonUnflattener(JsonCore<?>, Reader) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattener: Creates a JSON unflattener by given JsonCore and JSON string reader.
JsonUnflattener(JsonCore<?>, String) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattener: Creates a JSON unflattener by given JsonCore and JSON string.
JsonUnflattener(JsonCore<?>, Map<String, ?>) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattener: Creates a JSON unflattener by given JsonCore and flattened Map.
JsonUnflattener(Reader) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattener: Creates a JSON unflattener by given JSON string reader.
JsonUnflattener(String) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattener: Creates a JSON unflattener by given JSON string.
JsonUnflattener(Map<String, ?>) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattener: Creates a JSON unflattener by given flattened Map.
JsonUnflattenerFactory - Class in com.github.wnameless.json.unflattener: JsonUnflattenerFactory preserves the configuration of a JsonUnflattener, in doing so, any input JSON data can be used to create a JsonUnflattener object with the same configuration.
JsonUnflattenerFactory(Consumer<JsonUnflattener>) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattenerFactory: Returns a JsonUnflattenerFactory.
JsonUnflattenerFactory(Consumer<JsonUnflattener>, JsonCore<?>) - Constructor for class com.github.wnameless.json.unflattener.JsonUnflattenerFactory: Returns a JsonUnflattenerFactory.

K

KEEP_ARRAYS - Enum constant in enum class com.github.wnameless.json.flattener.FlattenMode: Flattens every object except arrays.
KEEP_PRIMITIVE_ARRAYS - Enum constant in enum class com.github.wnameless.json.flattener.FlattenMode: Flattens every object except arrays which contain only primitive types(strings, numbers, booleans, and null).
KeyTransformer - Interface in com.github.wnameless.json.flattener: KeyTransformer defines an interface to transform keys in JsonFlattener or JsonUnflattener.

M

MINIMAL - Enum constant in enum class com.github.wnameless.json.flattener.PrintMode: Prints output as minified JSON.
MONGODB - Enum constant in enum class com.github.wnameless.json.flattener.FlattenMode: Conforms to MongoDB dot.notation to update also nested documents.

N

newIndexedPeekIterator(Iterable<T>) - Static method in class com.github.wnameless.json.flattener.IndexedPeekIterator: Creates an IndexedPeekIterator by given Iterable.
next() - Method in class com.github.wnameless.json.flattener.IndexedPeekIterator
NORMAL - Enum constant in enum class com.github.wnameless.json.flattener.FlattenMode: Flattens every object.
NORMAL - Enum constant in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Deprecated.
for removal in 0.17.0 in favor of StringEscapePolicy.ALL_BUT_UNICODE

P

peek() - Method in class com.github.wnameless.json.flattener.IndexedPeekIterator: Peeks an element advanced.
PRETTY - Enum constant in enum class com.github.wnameless.json.flattener.PrintMode: Prints output in different lines with necessary indentations.
PrintMode - Enum Class in com.github.wnameless.json.flattener: PrintMode lists all acceptable JSON print mode of the JsonFlattener.

R

remove() - Method in class com.github.wnameless.json.flattener.IndexedPeekIterator
ROOT - Static variable in class com.github.wnameless.json.flattener.JsonFlattener: JsonFlattener.ROOT is the default key of the Map returned by JsonFlattener.flattenAsMap(com.github.wnameless.json.base.JsonValueBase<?>).
ROOT - Static variable in class com.github.wnameless.json.unflattener.JsonUnflattener: JsonUnflattener.ROOT is the default key of the Map returned by JsonUnflattener.unflattenAsMap(java.lang.String).

S

setTranslator(CharSequenceTranslator) - Method in class com.github.wnameless.json.flattener.JsonifyArrayList
setTranslator(CharSequenceTranslator) - Method in class com.github.wnameless.json.flattener.JsonifyLinkedHashMap
StringEscapePolicy - Enum Class in com.github.wnameless.json.flattener: StringEscapePolicy lists all acceptable JSON string escape policy of the JsonFlattener.

T

toString() - Method in class com.github.wnameless.json.flattener.JsonFlattener
toString() - Method in class com.github.wnameless.json.flattener.JsonFlattenerFactory
toString() - Method in class com.github.wnameless.json.flattener.JsonifyArrayList
toString() - Method in class com.github.wnameless.json.flattener.JsonifyLinkedHashMap
toString() - Method in class com.github.wnameless.json.unflattener.JsonUnflattener
toString() - Method in class com.github.wnameless.json.unflattener.JsonUnflattenerFactory
toString(PrintMode) - Method in class com.github.wnameless.json.flattener.JsonifyArrayList
toString(PrintMode) - Method in class com.github.wnameless.json.flattener.JsonifyLinkedHashMap
transform(String) - Method in interface com.github.wnameless.json.flattener.KeyTransformer: Transforms the given key by this function.

U

unflatten() - Method in class com.github.wnameless.json.unflattener.JsonUnflattener: Returns a JSON string of nested objects by the given flattened JSON string.
unflatten(String) - Static method in class com.github.wnameless.json.unflattener.JsonUnflattener: Returns a JSON string of nested objects by the given flattened JSON string.
unflatten(Map<String, ?>) - Static method in class com.github.wnameless.json.unflattener.JsonUnflattener: Returns a JSON string of nested objects by the given flattened Map.
unflattenAsMap() - Method in class com.github.wnameless.json.unflattener.JsonUnflattener: Returns a Java Map of nested objects by the given flattened JSON string.
unflattenAsMap(String) - Static method in class com.github.wnameless.json.unflattener.JsonUnflattener: Returns a Java Map of nested objects by the given flattened JSON string.
unflattenAsMap(Map<String, ?>) - Static method in class com.github.wnameless.json.unflattener.JsonUnflattener: Returns a Java Map of nested objects by the given flattened Map.

V

valueOf(String) - Static method in enum class com.github.wnameless.json.flattener.FlattenMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.wnameless.json.flattener.PrintMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.wnameless.json.flattener.FlattenMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.wnameless.json.flattener.PrintMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.wnameless.json.flattener.StringEscapePolicy: Returns an array containing the constants of this enum class, in the order they are declared.

W

withFlattenMode(FlattenMode) - Method in class com.github.wnameless.json.flattener.JsonFlattener: A fluent setter to setup a mode of the JsonFlattener.
withFlattenMode(FlattenMode) - Method in class com.github.wnameless.json.unflattener.JsonUnflattener: A fluent setter to setup a mode of the JsonUnflattener.
withKeyTransformer(KeyTransformer) - Method in class com.github.wnameless.json.flattener.JsonFlattener: A fluent setter to setup a KeyTransformer of the JsonFlattener.
withKeyTransformer(KeyTransformer) - Method in class com.github.wnameless.json.unflattener.JsonUnflattener: A fluent setter to setup a KeyTransformer of the JsonUnflattener.
withLeftAndRightBrackets(char, char) - Method in class com.github.wnameless.json.flattener.JsonFlattener: A fluent setter to setup the left and right brackets within a key in the flattened JSON.
withLeftAndRightBrackets(char, char) - Method in class com.github.wnameless.json.unflattener.JsonUnflattener: A fluent setter to setup the left and right brackets within a key in the flattened JSON.
withPrintMode(PrintMode) - Method in class com.github.wnameless.json.flattener.JsonFlattener: A fluent setter to setup a print mode of the JsonFlattener.
withPrintMode(PrintMode) - Method in class com.github.wnameless.json.unflattener.JsonUnflattener: A fluent setter to setup a print mode of the JsonUnflattener.
withSeparator(char) - Method in class com.github.wnameless.json.flattener.JsonFlattener: A fluent setter to setup the separator within a key in the flattened JSON.
withSeparator(char) - Method in class com.github.wnameless.json.unflattener.JsonUnflattener: A fluent setter to setup the separator within a key in the flattened JSON.
withStringEscapePolicy(CharSequenceTranslatorFactory) - Method in class com.github.wnameless.json.flattener.JsonFlattener: A fluent setter to setup the JSON string escape policy.

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