Record Class CitationSpan

java.lang.Object

java.lang.Record

com.github.copilot.generated.CitationSpan

@Generated("copilot-sdk-codegen")
public record CitationSpan(Long startIndex, Long endIndex, List<CitationReference> references)
extends Record

A contiguous span of generated assistant text and the source references that support it.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
CitationSpan(Long startIndex, Long endIndex, List<CitationReference> references)	Creates an instance of a CitationSpan record class.

Method Summary

Modifier and Type	Method	Description
Long	endIndex()	Returns the value of the endIndex record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<CitationReference>	references()	Returns the value of the references record component.
Long	startIndex()	Returns the value of the startIndex record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CitationSpan

public CitationSpan(Long startIndex,
 Long endIndex,
 List<CitationReference> references)

Creates an instance of a CitationSpan record class.

Parameters:

startIndex - the value for the startIndex record component

endIndex - the value for the endIndex record component

references - the value for the references record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

startIndex

public Long startIndex()

Returns the value of the startIndex record component.

Returns:

the value of the startIndex record component

endIndex

public Long endIndex()

Returns the value of the endIndex record component.

Returns:

the value of the endIndex record component

references

public List<CitationReference> references()

Returns the value of the references record component.

Returns:

the value of the references record component