org.json.stream

Interface LimitFilter

public interface LimitFilter

Filtering for structures during a parse. Provided by the BuilderLimits class to the StructureBuilder implementations.

Method Summary

Modifier and Type	Method and Description
boolean	acceptField(java.lang.String fieldName, JSONStreamReader.ParseState state, SizedIterable<StructureIdentifier> ids) Determine whether to accept or reject a value within an object.
boolean	acceptIndex(int index, JSONStreamReader.ParseState state, SizedIterable<StructureIdentifier> ids) Determine whether to accept or reject a value within an array.

Method Detail

acceptIndex

boolean acceptIndex(int index,
                    JSONStreamReader.ParseState state,
                    SizedIterable<StructureIdentifier> ids)

Determine whether to accept or reject a value within an array.

Parameters:

index - the array index within the current array

state - the type of value that will be built

ids - can be used to construct a JSON Pointer expression, or determine the depth of the current structure

Returns:

true to allow the value to be created, otherwise false to skip the value

See Also:

JSONPointerUtils.toJSONPointer(Iterable)

acceptField

boolean acceptField(java.lang.String fieldName,
                    JSONStreamReader.ParseState state,
                    SizedIterable<StructureIdentifier> ids)

Determine whether to accept or reject a value within an object.

Parameters:

fieldName - the key name within the current object

state - the type of value that will be built

ids - can be used to construct a JSON Pointer expression, or determine the depth of the current structure

Returns:

true to allow the value to be created, otherwise false to skip the value

See Also:

JSONPointerUtils.toJSONPointer(Iterable)