com.fasterxml.jackson.core.io

Class ContentReference

java.lang.Object

com.fasterxml.jackson.core.io.ContentReference

All Implemented Interfaces:

java.io.Serializable

public class ContentReference
extends java.lang.Object
implements java.io.Serializable

Abstraction that encloses information about content being processed -- input source or output target, streaming or not -- for the purpose of including pertinent information in location (see JsonLocation) objections, most commonly to be printed out as part of Exception messages.

Since:

2.13

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CONTENT_SNIPPET Deprecated. Since 2.16. ErrorReportConfiguration.DEFAULT_MAX_RAW_CONTENT_LENGTH will be used instead.

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuilder	appendSourceDescription(java.lang.StringBuilder sb) Method for appending a "source description" when content represented by this reference is read.
java.lang.String	buildSourceDescription() Method for constructing a "source description" when content represented by this reference is read.
static ContentReference	construct(boolean isContentTextual, java.lang.Object rawContent) Deprecated. Since 2.16. Use construct(boolean, Object, ErrorReportConfiguration) instead.
static ContentReference	construct(boolean isContentTextual, java.lang.Object rawContent, ErrorReportConfiguration errorReportConfiguration)
static ContentReference	construct(boolean isContentTextual, java.lang.Object rawContent, int offset, int length) Deprecated. Since 2.16. Use construct(boolean, Object, int, int, ErrorReportConfiguration) instead.
static ContentReference	construct(boolean isContentTextual, java.lang.Object rawContent, int offset, int length, ErrorReportConfiguration errorReportConfiguration)
int	contentLength()
int	contentOffset()
boolean	equals(java.lang.Object other)
java.lang.Object	getRawContent()
int	hashCode()
boolean	hasTextualContent()
static ContentReference	rawReference(boolean isContentTextual, java.lang.Object rawContent) Factory method for legacy code to use for constructing instances to content about which only minimal amount of information is available.
static ContentReference	rawReference(java.lang.Object rawContent)
static ContentReference	redacted() Accessor for getting a placeholder when actual content is not to be exposed: different from unknown() where content is not available to be referenced.
static ContentReference	unknown() Accessor for getting a placeholder for cases where actual content is not known (or is not something that system wants to expose).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MAX_CONTENT_SNIPPET

@Deprecated
public static final int DEFAULT_MAX_CONTENT_SNIPPET

Deprecated. Since 2.16. ErrorReportConfiguration.DEFAULT_MAX_RAW_CONTENT_LENGTH will be used instead.

Include at most first 500 characters/bytes from contents; should be enough to give context, but not cause unfortunate side effects in things like logs.

Since:

2.9

See Also:

Constant Field Values

Method Detail

unknown

public static ContentReference unknown()

Accessor for getting a placeholder for cases where actual content is not known (or is not something that system wants to expose).

Returns:

Placeholder "unknown" (or "empty") instance to use instead of null reference

redacted

public static ContentReference redacted()

Accessor for getting a placeholder when actual content is not to be exposed: different from unknown() where content is not available to be referenced.

Returns:

Placeholder instance to use in cases where reference is explicitly blocked, usually for security reasons.

Since:

2.16

construct

@Deprecated
public static ContentReference construct(boolean isContentTextual,
                                                     java.lang.Object rawContent)

Deprecated. Since 2.16. Use construct(boolean, Object, ErrorReportConfiguration) instead.

construct

@Deprecated
public static ContentReference construct(boolean isContentTextual,
                                                     java.lang.Object rawContent,
                                                     int offset,
                                                     int length)

Deprecated. Since 2.16. Use construct(boolean, Object, int, int, ErrorReportConfiguration) instead.

construct

public static ContentReference construct(boolean isContentTextual,
                                         java.lang.Object rawContent,
                                         int offset,
                                         int length,
                                         ErrorReportConfiguration errorReportConfiguration)

Since:

2.16

construct

public static ContentReference construct(boolean isContentTextual,
                                         java.lang.Object rawContent,
                                         ErrorReportConfiguration errorReportConfiguration)

Since:

2.16

rawReference

public static ContentReference rawReference(boolean isContentTextual,
                                            java.lang.Object rawContent)

Factory method for legacy code to use for constructing instances to content about which only minimal amount of information is available. Assumed not to contain textual content (no snippet displayed).

Parameters:

isContentTextual - Is raw content assumed to have textual content (true) or binary (false)

rawContent - Underlying raw content access

Returns:

Instance with minimal information about content (basically just raw content reference without offsets

rawReference

public static ContentReference rawReference(java.lang.Object rawContent)

hasTextualContent

public boolean hasTextualContent()

getRawContent

public java.lang.Object getRawContent()

contentOffset

public int contentOffset()

contentLength

public int contentLength()

buildSourceDescription

public java.lang.String buildSourceDescription()

Method for constructing a "source description" when content represented by this reference is read.

Returns:

Description constructed

appendSourceDescription

public java.lang.StringBuilder appendSourceDescription(java.lang.StringBuilder sb)

Method for appending a "source description" when content represented by this reference is read.

Parameters:

sb - StringBuilder to append description to

Returns:

StringBuilder passed as argument (for call chaining)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object