Class CitationCharLocation
-
- All Implemented Interfaces:
public final class CitationCharLocation
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCitationCharLocation.BuilderA builder for CitationCharLocation.
-
Method Summary
Modifier and Type Method Description final CitationCharLocationParamtoParam()final StringcitedText()final LongdocumentIndex()final Optional<String>documentTitle()final LongendCharIndex()final Optional<String>fileId()final LongstartCharIndex()final JsonValue_type()Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("char_location")final JsonField<String>_citedText()Returns the raw JSON value of citedText. final JsonField<Long>_documentIndex()Returns the raw JSON value of documentIndex. final JsonField<String>_documentTitle()Returns the raw JSON value of documentTitle. final JsonField<Long>_endCharIndex()Returns the raw JSON value of endCharIndex. final JsonField<String>_fileId()Returns the raw JSON value of fileId. final JsonField<Long>_startCharIndex()Returns the raw JSON value of startCharIndex. final Map<String, JsonValue>_additionalProperties()final CitationCharLocation.BuildertoBuilder()final CitationCharLocationvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static CitationCharLocation.Builderbuilder()Returns a mutable builder for constructing an instance of CitationCharLocation. -
-
Method Detail
-
toParam
final CitationCharLocationParam toParam()
-
documentIndex
final Long documentIndex()
-
documentTitle
final Optional<String> documentTitle()
-
endCharIndex
final Long endCharIndex()
-
startCharIndex
final Long startCharIndex()
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("char_location")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_citedText
final JsonField<String> _citedText()
Returns the raw JSON value of citedText.
Unlike citedText, this method doesn't throw if the JSON field has an unexpected type.
-
_documentIndex
final JsonField<Long> _documentIndex()
Returns the raw JSON value of documentIndex.
Unlike documentIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_documentTitle
final JsonField<String> _documentTitle()
Returns the raw JSON value of documentTitle.
Unlike documentTitle, this method doesn't throw if the JSON field has an unexpected type.
-
_endCharIndex
final JsonField<Long> _endCharIndex()
Returns the raw JSON value of endCharIndex.
Unlike endCharIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_fileId
final JsonField<String> _fileId()
Returns the raw JSON value of fileId.
Unlike fileId, this method doesn't throw if the JSON field has an unexpected type.
-
_startCharIndex
final JsonField<Long> _startCharIndex()
Returns the raw JSON value of startCharIndex.
Unlike startCharIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final CitationCharLocation.Builder toBuilder()
-
validate
final CitationCharLocation validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static CitationCharLocation.Builder builder()
Returns a mutable builder for constructing an instance of CitationCharLocation.
The following fields are required:
.citedText() .documentIndex() .documentTitle() .endCharIndex() .fileId() .startCharIndex()
-
-
-
-