Enum Class Citation.LocationType

java.lang.Object

java.lang.Enum<Citation.LocationType>

org.springframework.ai.anthropic.Citation.LocationType

All Implemented Interfaces:

Serializable, Comparable<Citation.LocationType>, Constable

Enclosing class:

Citation

public static enum Citation.LocationType
extends Enum<Citation.LocationType>

Types of citation locations based on document format.

Since:

1.1.0

Author:

Soby Chacko

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHAR_LOCATION	Character-based location for plain text documents
CONTENT_BLOCK_LOCATION	Block-based location for custom content documents
PAGE_LOCATION	Page-based location for PDF documents

Method Summary

Modifier and Type	Method	Description
static Citation.LocationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Citation.LocationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CHAR_LOCATION

public static final Citation.LocationType CHAR_LOCATION

Character-based location for plain text documents

PAGE_LOCATION

public static final Citation.LocationType PAGE_LOCATION

Page-based location for PDF documents

CONTENT_BLOCK_LOCATION

public static final Citation.LocationType CONTENT_BLOCK_LOCATION

Block-based location for custom content documents

Method Details

values

public static Citation.LocationType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Citation.LocationType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null