Module tools.jackson.core
Package tools.jackson.core.json

Class JsonReadContext

java.lang.Object
tools.jackson.core.TokenStreamContext
tools.jackson.core.json.JsonReadContext
public class JsonReadContext extends TokenStreamContext
Extension of TokenStreamContext, which implements core methods needed, and also exposes more complete API to parser implementation classes.

  • Field Details

    • _parent

      protected final JsonReadContext _parent
      Parent context for this context; null for root context.

    • _dups

      protected DupDetector _dups

    • _child

      protected JsonReadContext _child

    • _currentName

      protected String _currentName

    • _currentValue

      protected Object _currentValue

    • _lineNr

      protected int _lineNr

    • _columnNr

      protected int _columnNr

  • Constructor Details

    • JsonReadContext

      public JsonReadContext(JsonReadContext parent, int nestingDepth, DupDetector dups, int type, int lineNr, int colNr)
      Parameters:
      parent - Parent context, if any (null for Root context)
      nestingDepth - Number of parents this context has (0 for Root context)
      dups - Detector used for checking duplicate names, if any (null if none)
      type - Type to assign to this context node
      lineNr - Line of the starting position of this context
      colNr - Column of the starting position of this context
      Since:
      2.15

  • Method Details

    • reset

      public JsonReadContext reset(int type, int lineNr, int colNr)
      Internal method to allow instance reuse: DO NOT USE unless you absolutely know what you are doing. Clears up state (including "current value"), changes type to one specified; resets current duplicate-detection state (if any). Parent link left as-is since it is final.
      Parameters:
      type - Type to assign to this context node
      lineNr - Line of the starting position of this context
      colNr - Column of the starting position of this context
      Returns:
      This context instance (to allow call-chaining)

    • withDupDetector

      public JsonReadContext withDupDetector(DupDetector dups)

    • currentValue

      public Object currentValue()
      Description copied from class: TokenStreamContext
      Method for accessing currently active value being used by data-binding (as the source of streaming data to write, or destination of data being read), at this level in hierarchy.

      Note that "current value" is NOT populated (or used) by Streaming parser or generator; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.

      Overrides:
      currentValue in class TokenStreamContext
      Returns:
      Currently active value, if one has been assigned.

    • assignCurrentValue

      public void assignCurrentValue(Object v)
      Description copied from class: TokenStreamContext
      Method to call to pass value to be returned via TokenStreamContext.currentValue(); typically called indirectly through JsonParser.assignCurrentValue(java.lang.Object) or JsonGenerator.assignCurrentValue(java.lang.Object)).
      Overrides:
      assignCurrentValue in class TokenStreamContext
      Parameters:
      v - Current value to assign to this context

    • createRootContext

      public static JsonReadContext createRootContext(int lineNr, int colNr, DupDetector dups)

    • createRootContext

      public static JsonReadContext createRootContext(DupDetector dups)

    • createChildArrayContext

      public JsonReadContext createChildArrayContext(int lineNr, int colNr)

    • createChildObjectContext

      public JsonReadContext createChildObjectContext(int lineNr, int colNr)

    • currentName

      public String currentName()
      Description copied from class: TokenStreamContext
      Method for accessing name associated with the current location. Non-null for PROPERTY_NAME and value events that directly follow Property names; null for root level and array values.
      Specified by:
      currentName in class TokenStreamContext
      Returns:
      Current property name within context, if any; null if none
      Since:
      3.0

    • hasCurrentName

      public boolean hasCurrentName()
      Overrides:
      hasCurrentName in class TokenStreamContext

    • getParent

      public JsonReadContext getParent()
      Description copied from class: TokenStreamContext
      Accessor for finding parent context of this context; will return null for root context.
      Specified by:
      getParent in class TokenStreamContext
      Returns:
      Parent context of this context, if any; null for Root contexts

    • startLocation

      public TokenStreamLocation startLocation(ContentReference srcRef)
      Description copied from class: TokenStreamContext
      Optional method that may be used to access starting location of this context: for example, in case of JSON `Object` context, offset at which `[` token was read or written. Often used for error reporting purposes. Implementations that do not keep track of such location are expected to return TokenStreamLocation.NA; this is what the default implementation does.
      Overrides:
      startLocation in class TokenStreamContext
      Parameters:
      srcRef - Source reference needed to construct location instance
      Returns:
      Location pointing to the point where the context start marker was found (or written); never null.

    • clearAndGetParent

      public JsonReadContext clearAndGetParent()
      Method that can be used to both clear the accumulated references (specifically value set with assignCurrentValue(Object)) that should not be retained, and returns parent (as would getParent() do). Typically called when closing the active context when encountering JsonToken.END_ARRAY or JsonToken.END_OBJECT.
      Returns:
      Parent context of this context node, if any; null for root context

    • getDupDetector

      public DupDetector getDupDetector()

    • expectComma

      public boolean expectComma()

    • setCurrentName

      public void setCurrentName(String name) throws StreamReadException
      Method that parser is to call when it reads a name of Object property.
      Parameters:
      name - Property name that has been read
      Throws:
      StreamReadException - if duplicate check restriction is violated (which assumes that duplicate-detection is enabled)