Package com.fasterxml.jackson.core

Class JsonLocation

  • All Implemented Interfaces:
    java.io.Serializable
    public class JsonLocation
extends java.lang.Object
implements java.io.Serializable
    Object that encapsulates Location information used for reporting parsing (or potentially generation) errors, as well as current location within input streams.

    NOTE: users should be careful if using equals(java.lang.Object) implementation as it may or may not compare underlying "content reference" for equality. Instead if would make sense to explicitly implementing equality checks using specific criteria caller desires.

    See Also:
    Serialized Form

    • Field Detail

      • NA

        public static final JsonLocation NA
        Shared immutable "N/A location" that can be returned to indicate that no location information is available.

        NOTE: before 2.9, Location was given as String "N/A"; with 2.9 it was removed so that source should be indicated as "UNKNOWN".

    • Constructor Detail

      • JsonLocation

        public JsonLocation​(ContentReference contentRef,
                    long totalChars,
                    int lineNr,
                    int colNr)

      • JsonLocation

        public JsonLocation​(ContentReference contentRef,
                    long totalBytes,
                    long totalChars,
                    int lineNr,
                    int columnNr)

      • JsonLocation

        @Deprecated
public JsonLocation​(java.lang.Object srcRef,
                    long totalChars,
                    int lineNr,
                    int columnNr)
        Deprecated.

      • JsonLocation

        @Deprecated
public JsonLocation​(java.lang.Object srcRef,
                    long totalBytes,
                    long totalChars,
                    int lineNr,
                    int columnNr)
        Deprecated.

    • Method Detail

      • contentReference

        public ContentReference contentReference()
        Accessor for information about the original input source content is being read from. Returned reference is never null but may not contain useful information.

        NOTE: not getter, on purpose, to avoid inlusion if serialized using default Jackson serializer.

        Returns:
        Object with information about input source.
        Since:
        2.13 (to replace getSourceRef)

      • getSourceRef

        @Deprecated
public java.lang.Object getSourceRef()
        Deprecated.
        Since 2.13 Use contentReference() instead
        Reference to the original resource being read, if one available. For example, when a parser has been constructed by passing a File instance, this method would return that File. Will return null if no such reference is available, for example when InputStream was used to construct the parser instance.
        Returns:
        Source reference this location was constructed with, if any; null if none

      • getLineNr

        public int getLineNr()
        Access for getting line number of this location, if available. Note that line number is typically not available for binary formats.
        Returns:
        Line number of the location (1-based), if available; -1 if not.

      • getColumnNr

        public int getColumnNr()
        Access for getting column offset of this location, if available. Note that column position is typically not available for binary formats. Note: this returns an offset that is in units of input, so for byte-based input sources (like InputStream) this does not take into account multi-byte characters: one logical character can be 1, 2 or 3 bytes long. To calculate column position in characters either char-based input source (like Reader) needs to be used, or content needs to be explicitly decoded.
        Returns:
        Column offset of the location (1-based), if available; -1 if not.

      • getCharOffset

        public long getCharOffset()
        Returns:
        Character offset within underlying stream, reader or writer, if available; -1 if not.

      • getByteOffset

        public long getByteOffset()
        Returns:
        Byte offset within underlying stream, reader or writer, if available; -1 if not.

      • sourceDescription

        public java.lang.String sourceDescription()
        Accessor for getting a textual description of source reference (Object returned by getSourceRef()), as included in description returned by toString().

        Note: implementation will simply call ContentReference.buildSourceDescription())

        NOTE: not added as a "getter" to prevent it from getting serialized.

        Returns:
        Description of the source reference (see getSourceRef()
        Since:
        2.9

      • offsetDescription

        public java.lang.String offsetDescription()
        Accessor for a brief summary of Location offsets (line number, column position, or byte offset, if available).
        Returns:
        Description of available relevant location offsets; combination of line number and column position or byte offset
        Since:
        2.13

      • appendOffsetDescription

        public java.lang.StringBuilder appendOffsetDescription​(java.lang.StringBuilder sb)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object