Module org.apache.lucene.codecs
Record Class BlockTermsWriter.FieldMetaData
java.lang.Object
java.lang.Record
org.apache.lucene.codecs.blockterms.BlockTermsWriter.FieldMetaData
- Enclosing class:
BlockTermsWriter
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
The field for thedocCount
record component.private final FieldInfo
The field for thefieldInfo
record component.private final long
The field for thenumTerms
record component.private final long
The field for thesumDocFreq
record component.private final long
The field for thesumTotalTermFreq
record component.private final long
The field for thetermsStartPointer
record component. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
FieldMetaData
(FieldInfo fieldInfo, long numTerms, long termsStartPointer, long sumTotalTermFreq, long sumDocFreq, int docCount) Creates an instance of aFieldMetaData
record class. -
Method Summary
Modifier and TypeMethodDescriptionint
docCount()
Returns the value of thedocCount
record component.final boolean
Indicates whether some other object is "equal to" this one.Returns the value of thefieldInfo
record component.final int
hashCode()
Returns a hash code value for this object.long
numTerms()
Returns the value of thenumTerms
record component.long
Returns the value of thesumDocFreq
record component.long
Returns the value of thesumTotalTermFreq
record component.long
Returns the value of thetermsStartPointer
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
fieldInfo
The field for thefieldInfo
record component. -
numTerms
private final long numTermsThe field for thenumTerms
record component. -
termsStartPointer
private final long termsStartPointerThe field for thetermsStartPointer
record component. -
sumTotalTermFreq
private final long sumTotalTermFreqThe field for thesumTotalTermFreq
record component. -
sumDocFreq
private final long sumDocFreqThe field for thesumDocFreq
record component. -
docCount
private final int docCountThe field for thedocCount
record component.
-
-
Constructor Details
-
FieldMetaData
private FieldMetaData(FieldInfo fieldInfo, long numTerms, long termsStartPointer, long sumTotalTermFreq, long sumDocFreq, int docCount) Creates an instance of aFieldMetaData
record class.- Parameters:
fieldInfo
- the value for thefieldInfo
record componentnumTerms
- the value for thenumTerms
record componenttermsStartPointer
- the value for thetermsStartPointer
record componentsumTotalTermFreq
- the value for thesumTotalTermFreq
record componentsumDocFreq
- the value for thesumDocFreq
record componentdocCount
- the value for thedocCount
record component
-
-
Method Details
-
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. -
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. -
equals
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. Reference components are compared withObjects::equals(Object,Object)
; primitive components are compared with '=='. -
fieldInfo
Returns the value of thefieldInfo
record component.- Returns:
- the value of the
fieldInfo
record component
-
numTerms
public long numTerms()Returns the value of thenumTerms
record component.- Returns:
- the value of the
numTerms
record component
-
termsStartPointer
public long termsStartPointer()Returns the value of thetermsStartPointer
record component.- Returns:
- the value of the
termsStartPointer
record component
-
sumTotalTermFreq
public long sumTotalTermFreq()Returns the value of thesumTotalTermFreq
record component.- Returns:
- the value of the
sumTotalTermFreq
record component
-
sumDocFreq
public long sumDocFreq()Returns the value of thesumDocFreq
record component.- Returns:
- the value of the
sumDocFreq
record component
-
docCount
public int docCount()Returns the value of thedocCount
record component.- Returns:
- the value of the
docCount
record component
-