org.hibernate.search.elasticsearch.gson.impl

Class JsonAccessor

java.lang.Object

org.hibernate.search.elasticsearch.gson.impl.JsonAccessor

public abstract class JsonAccessor
extends Object

A class that abstracts the ways of accessing values in a JSON tree.

Author:

Yoann Rodiere

Constructor Summary

Constructors

Constructor and Description
JsonAccessor()

Method Summary

Modifier and Type	Method and Description
abstract void	add(com.google.gson.JsonObject root, com.google.gson.JsonPrimitive newValue) Add the given primitive value to the element this accessor points to for the given root.
JsonAccessor	element(int index)
abstract com.google.gson.JsonElement	get(com.google.gson.JsonObject root) Get the current value of the element this accessor points to for the given root.
abstract <T extends com.google.gson.JsonElement> T	getOrCreate(com.google.gson.JsonObject root, JsonElementType<T> type) Get the current value of the lement this accessor points to for the given root, creating it and setting it if it hasn't been set yet.
abstract String	getStaticAbsolutePath()
JsonAccessor	property(String propertyName)
static JsonAccessor	root()
abstract void	set(com.google.gson.JsonObject root, com.google.gson.JsonElement newValue) Set the given value on the element this accessor points to for the given root.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonAccessor

public JsonAccessor()

Method Detail

get

public abstract com.google.gson.JsonElement get(com.google.gson.JsonObject root)

Get the current value of the element this accessor points to for the given root.

Parameters:

root - The root to be accessed.

Returns:

The current value pointed to by this accessor on the root, or null if it doesn't exist.

set

public abstract void set(com.google.gson.JsonObject root,
                         com.google.gson.JsonElement newValue)
                  throws UnexpectedJsonElementTypeException

Set the given value on the element this accessor points to for the given root.

Parameters:

root - The root to be accessed.

newValue - The value to set.

Throws:

UnexpectedJsonElementTypeException - If an element in the path has unexpected type, preventing access to the element this accessor points to.

add

public abstract void add(com.google.gson.JsonObject root,
                         com.google.gson.JsonPrimitive newValue)
                  throws UnexpectedJsonElementTypeException

Add the given primitive value to the element this accessor points to for the given root.

This method differs from set(JsonObject, JsonElement):

• If there is currently no value, the given value is simply set.
• If the current value is an array, the given value is added to this array.
• If the current value is a primitive or JsonNull, the current value is replaced by an array containing the current value followed by the given value.
• Otherwise (i.e. if the current value is an object), an UnexpectedJsonElementTypeException is thrown.

Parameters:

root - The root to be accessed.

newValue - The value to add.

Throws:

UnexpectedJsonElementTypeException - If an element in the path has unexpected type, preventing write access to the element this accessor points to.

getOrCreate

public abstract <T extends com.google.gson.JsonElement> T getOrCreate(com.google.gson.JsonObject root,
                                                                      JsonElementType<T> type)
                                                               throws UnexpectedJsonElementTypeException

Get the current value of the lement this accessor points to for the given root, creating it and setting it if it hasn't been set yet.

Parameters:

root - The root to be accessed.

type - The expected JsonElementType.

Returns:

The current value pointed to by this accessor on the root, always non-null and typed according to type.

Throws:

UnexpectedJsonElementTypeException - if the element already exists and is not of type type, or if an element in the path has unexpected type, preventing access to the element this accessor points to.

getStaticAbsolutePath

public abstract String getStaticAbsolutePath()

Returns:

The absolute path representing this accessor, excluding runtime details such as array indices. null for the root accessor.

root

public static JsonAccessor root()

property

public JsonAccessor property(String propertyName)

element

public JsonAccessor element(int index)