Class ContentReference
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.io.ContentReference
- All Implemented Interfaces:
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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final boolean
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
For static content, indicates length of content in the static array.protected final int
For static content, indicates offset from the beginning of static array.protected final Object
Reference to the actual underlying content.static final int
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
Constant that may be used when source/target content is not known (or not exposed). -
Constructor Summary
ModifierConstructorDescriptionprotected
ContentReference
(boolean isContentTextual, Object rawContent) protected
ContentReference
(boolean isContentTextual, Object rawContent, int offset, int length) -
Method Summary
Modifier and TypeMethodDescriptionprotected int
_append
(StringBuilder sb, String content) protected boolean
_appendEscaped
(StringBuilder sb, int ctrlChar) protected String
_truncate
(byte[] b, int[] offsets, int maxSnippetLen) protected String
_truncate
(char[] cs, int[] offsets, int maxSnippetLen) protected String
_truncate
(CharSequence cs, int[] offsets, int maxSnippetLen) protected void
_truncateOffsets
(int[] offsets, int actualLength) Method for appending a "source description" when content represented by this reference is read.Method for constructing a "source description" when content represented by this reference is read.static ContentReference
static ContentReference
int
int
boolean
int
hashCode()
boolean
protected int
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)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.static ContentReference
rawReference
(Object rawContent) protected Object
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).
-
Field Details
-
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.
-
DEFAULT_MAX_CONTENT_SNIPPET
public static final int DEFAULT_MAX_CONTENT_SNIPPETInclude 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:
-
_rawContent
Reference to the actual underlying content. -
_offset
protected final int _offsetFor static content, indicates offset from the beginning of static array.-1
if not in use. -
_length
protected final int _lengthFor static content, indicates length of content in the static array.-1
if not in use. -
_isContentTextual
protected final boolean _isContentTextualMarker 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.
-
-
Constructor Details
-
ContentReference
-
ContentReference
-
-
Method Details
-
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
-
construct
-
construct
public static ContentReference construct(boolean isContentTextual, Object rawContent, int offset, int length) -
rawReference
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
-
readResolve
-
hasTextualContent
public boolean hasTextualContent() -
getRawContent
-
contentOffset
public int contentOffset() -
contentLength
public int contentLength() -
maxContentSnippetLength
protected int maxContentSnippetLength()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:
- Maximum content snippet to include before truncating
-
buildSourceDescription
Method for constructing a "source description" when content represented by this reference is read.- Returns:
- Description constructed
-
appendSourceDescription
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)
-
_truncate
-
_truncate
-
_truncate
-
_truncateOffsets
protected void _truncateOffsets(int[] offsets, int actualLength) -
_append
-
_appendEscaped
-
equals
-
hashCode
public int hashCode()
-