Jackson-core 2.16.0 · com.fasterxml.jackson.core.io.ContentReference

Modifier and Type	Field and Description
protected final boolean	_isContentTextual Marker flag to indicate whether included content is textual or not: this is taken to mean, by default, that a snippet of content may be displayed for exception messages.
protected final int	_length For static content, indicates length of content in the static array.
protected final int	_maxRawContentLength max raw content to return as configured
protected final int	_offset For static content, indicates offset from the beginning of static array.
protected final transient Object	_rawContent Reference to the actual underlying content.
public static final int	DEFAULT_MAX_CONTENT_SNIPPET 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.
protected static final ContentReference	REDACTED_CONTENT As content will be redacted by default in Jackson 2.16 and later, we'll use a new marker reference for slightly different description from "unknown", to indicate explicit removal of source/content reference (as opposed to it missing from not being available or so)
private static final long	serialVersionUID
protected static final ContentReference	UNKNOWN_CONTENT Constant that may be used when source/target content is not known (or not exposed).

Access	Constructor and Description
protected	ContentReference(boolean isContentTextual, Object rawContent) Deprecated Since 2.16.
protected	ContentReference(boolean isContentTextual, Object rawContent, int offset, int length) Deprecated Since 2.16.
protected	ContentReference(boolean isContentTextual, Object rawContent, ErrorReportConfiguration errorReportConfiguration)
protected	ContentReference(boolean isContentTextual, Object rawContent, int offset, int length, ErrorReportConfiguration errorReportConfiguration)

Method Summary

Modifier and Type	Method and Description
protected int	_append(StringBuilder sb, String content)
protected boolean	_appendEscaped(StringBuilder sb, int ctrlChar)
protected String	_truncate(CharSequence cs, int[] offsets, int maxSnippetLen)
protected String	_truncate(char[] cs, int[] offsets, int maxSnippetLen)
protected String	_truncate(byte[] b, int[] offsets, int maxSnippetLen)
protected void	_truncateOffsets(int[] offsets, int actualLength)
public StringBuilder	Returns: StringBuilder passed as argument (for call chaining) appendSourceDescription(StringBuilder StringBuilder to append description to sb) Method for appending a "source description" when content represented by this reference is read.
public String	Returns: Description constructed buildSourceDescription() Method for constructing a "source description" when content represented by this reference is read.
public static ContentReference	construct(boolean isContentTextual, Object rawContent) Deprecated Since 2.16.
public static ContentReference	construct(boolean isContentTextual, Object rawContent, int offset, int length) Deprecated Since 2.16.
public static ContentReference	construct(boolean isContentTextual, Object rawContent, int offset, int length, ErrorReportConfiguration errorReportConfiguration)
public static ContentReference	construct(boolean isContentTextual, Object rawContent, ErrorReportConfiguration errorReportConfiguration)
public int	contentLength()
public int	contentOffset()
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Object	getRawContent()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	hasTextualContent()
protected int	Returns: Maximum content snippet to include before truncating maxRawContentLength() Internal accessor, overridable, used for checking length (in units in which content is counted, either bytes or chars) to use for truncation (so as not to include full content for humongous sources or targets)
public static ContentReference	Returns: Instance with minimal information about content (basically just raw content reference without offsets rawReference(boolean Is raw content assumed to have textual content (`true`) or binary (`false`) isContentTextual, Object Underlying raw content access rawContent) Factory method for legacy code to use for constructing instances to content about which only minimal amount of information is available.
public static ContentReference	rawReference(Object rawContent)
private void	readObject(ObjectInputStream in)
protected Object	readResolve()
public static ContentReference	Returns: Placeholder instance to use in cases where reference is explicitly blocked, usually for security reasons. 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.
public static ContentReference	Returns: Placeholder "unknown" (or "empty") instance to use instead of `null` reference unknown() Accessor for getting a placeholder for cases where actual content is not known (or is not something that system wants to expose).
private void	writeObject(ObjectOutputStream out)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

_isContentTextual	back to summary
protected final boolean _isContentTextual Marker flag to indicate whether included content is textual or not: this is taken to mean, by default, that a snippet of content may be displayed for exception messages.

_length	back to summary
protected final int _length For static content, indicates length of content in the static array. `-1` if not in use.

_maxRawContentLength	back to summary
protected final int _maxRawContentLength max raw content to return as configured Since 2.16

_maxRawContentLength

back to summary

protected final int _maxRawContentLength

max raw content to return as configured

Since: 2.16

_offset	back to summary
protected final int _offset For static content, indicates offset from the beginning of static array. `-1` if not in use.

_rawContent	back to summary
protected final transient Object _rawContent Reference to the actual underlying content.

DEFAULT_MAX_CONTENT_SNIPPET	back to summary
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. Annotations @Deprecated Since 2.9

REDACTED_CONTENT	back to summary
protected static final ContentReference REDACTED_CONTENT As content will be redacted by default in Jackson 2.16 and later, we'll use a new marker reference for slightly different description from "unknown", to indicate explicit removal of source/content reference (as opposed to it missing from not being available or so) Since 2.16

REDACTED_CONTENT

back to summary

protected static final ContentReference REDACTED_CONTENT

As content will be redacted by default in Jackson 2.16 and later, we'll use a new marker reference for slightly different description from "unknown", to indicate explicit removal of source/content reference (as opposed to it missing from not being available or so)

Since: 2.16

serialVersionUID	back to summary
private static final long serialVersionUID

UNKNOWN_CONTENT	back to summary
protected static final ContentReference UNKNOWN_CONTENT Constant that may be used when source/target content is not known (or not exposed). Note As of 2.13 assume to contain Binary content, meaning that no content snippets will be included.

Constructor Detail

ContentReference	back to summary
protected ContentReference(boolean isContentTextual, Object rawContent) Deprecated Since 2.16. Use `ContentReference(boolean, Object, ErrorReportConfiguration)` instead. Annotations @Deprecated

ContentReference	back to summary
protected ContentReference(boolean isContentTextual, Object rawContent, int offset, int length) Deprecated Since 2.16. Use `ContentReference(boolean, Object, int, int, ErrorReportConfiguration)` instead. Annotations @Deprecated

ContentReference	back to summary
protected ContentReference(boolean isContentTextual, Object rawContent, ErrorReportConfiguration errorReportConfiguration) Since 2.16

ContentReference	back to summary
protected ContentReference(boolean isContentTextual, Object rawContent, int offset, int length, ErrorReportConfiguration errorReportConfiguration) Since 2.16

Method Detail

_append	back to summary
protected int _append(StringBuilder sb, String content)

_appendEscaped	back to summary
protected boolean _appendEscaped(StringBuilder sb, int ctrlChar)

_truncate	back to summary
protected String _truncate(CharSequence cs, int[] offsets, int maxSnippetLen)

_truncate	back to summary
protected String _truncate(char[] cs, int[] offsets, int maxSnippetLen)

_truncate	back to summary
protected String _truncate(byte[] b, int[] offsets, int maxSnippetLen)

_truncateOffsets	back to summary
protected void _truncateOffsets(int[] offsets, int actualLength)

appendSourceDescription	back to summary
public StringBuilder appendSourceDescription(StringBuilder sb) Method for appending a "source description" when content represented by this reference is read. Parameters sb:StringBuilder StringBuilder to append description to Returns:StringBuilder StringBuilder passed as argument (for call chaining)

appendSourceDescription

back to summary

public StringBuilder appendSourceDescription(StringBuilder sb)

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

Parameters

sb:StringBuilder: StringBuilder to append description to

Returns:StringBuilder

StringBuilder passed as argument (for call chaining)

buildSourceDescription	back to summary
public String buildSourceDescription() Method for constructing a "source description" when content represented by this reference is read. Returns:String Description constructed

buildSourceDescription

back to summary

public String buildSourceDescription()

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

Returns:String: Description constructed

construct	back to summary
public static ContentReference construct(boolean isContentTextual, Object rawContent) Deprecated Since 2.16. Use `construct(boolean, Object, ErrorReportConfiguration)` instead. Annotations @Deprecated

construct	back to summary
public static ContentReference construct(boolean isContentTextual, Object rawContent, int offset, int length) Deprecated Since 2.16. Use `construct(boolean, Object, int, int, ErrorReportConfiguration)` instead. Annotations @Deprecated

construct	back to summary
public static ContentReference construct(boolean isContentTextual, Object rawContent, int offset, int length, ErrorReportConfiguration errorReportConfiguration) Since 2.16

construct	back to summary
public static ContentReference construct(boolean isContentTextual, Object rawContent, ErrorReportConfiguration errorReportConfiguration) Since 2.16

contentLength	back to summary
public int contentLength()

contentOffset	back to summary
public int contentOffset()

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getRawContent	back to summary
public Object getRawContent()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasTextualContent	back to summary
public boolean hasTextualContent()

maxRawContentLength back to summary

maxRawContentLength	back to summary
protected int maxRawContentLength() Internal accessor, overridable, used for checking length (in units in which content is counted, either bytes or chars) to use for truncation (so as not to include full content for humongous sources or targets) Returns:int Maximum content snippet to include before truncating See Also `ErrorReportConfiguration#getMaxRawContentLength()`

protected int maxRawContentLength()

Internal accessor, overridable, used for checking length (in units in which content is counted, either bytes or chars) to use for truncation (so as not to include full content for humongous sources or targets)

Returns:int: Maximum content snippet to include before truncating
See Also: ErrorReportConfiguration#getMaxRawContentLength()

rawReference back to summary

rawReference	back to summary
public static ContentReference rawReference(boolean isContentTextual, 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:boolean Is raw content assumed to have textual content (`true`) or binary (`false`) rawContent:Object Underlying raw content access Returns:ContentReference Instance with minimal information about content (basically just raw content reference without offsets

public static ContentReference rawReference(boolean isContentTextual, 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:boolean: Is raw content assumed to have textual content (true) or binary (false)
rawContent:Object: Underlying raw content access

Returns:ContentReference

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

rawReference	back to summary
public static ContentReference rawReference(Object rawContent)

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException

readResolve	back to summary
protected Object readResolve()

redacted back to summary

redacted	back to summary
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:ContentReference Placeholder instance to use in cases where reference is explicitly blocked, usually for security reasons. Since 2.16

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:ContentReference: Placeholder instance to use in cases where reference is explicitly blocked, usually for security reasons.
Since: 2.16

unknown back to summary

unknown	back to summary
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:ContentReference Placeholder "unknown" (or "empty") instance to use instead of `null` reference

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:ContentReference: Placeholder "unknown" (or "empty") instance to use instead of null reference

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException

public Class ContentReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail