Package org.apache.lucene.util.fst
Class Outputs<T>
java.lang.Object
org.apache.lucene.util.fst.Outputs<T>
- Direct Known Subclasses:
ByteSequenceOutputs
,CharSequenceOutputs
,IntSequenceOutputs
,NoOutputs
,PairOutputs
,PositiveIntOutputs
Represents the outputs for an FST, providing the basic algebra required for building and
traversing the FST.
Note that any operation that returns NO_OUTPUT must return the same singleton object from
getNoOutput()
.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract T
Eg add("foo", "bar") -> "foobar"abstract T
Eg common("foobar", "food") -> "foo"abstract T
NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no outputabstract String
outputToString
(T output) abstract long
ramBytesUsed
(T output) Return memory usage for the provided output.abstract T
Decode an output value previously written withwrite(Object, DataOutput)
.Decode an output value previously written withwriteFinalOutput(Object, DataOutput)
.void
Skip the output previously written withwriteFinalOutput(T, org.apache.lucene.store.DataOutput)
; defaults to just callingreadFinalOutput(org.apache.lucene.store.DataInput)
and discarding the result.void
skipOutput
(DataInput in) Skip the output; defaults to just callingread(org.apache.lucene.store.DataInput)
and discarding the result.abstract T
Eg subtract("foobar", "foo") -> "bar"abstract void
write
(T output, DataOutput out) Encode an output value into aDataOutput
.void
writeFinalOutput
(T output, DataOutput out) Encode an final node output value into aDataOutput
.
-
Constructor Details
-
Outputs
public Outputs()
-
-
Method Details
-
common
Eg common("foobar", "food") -> "foo" -
subtract
Eg subtract("foobar", "foo") -> "bar" -
add
Eg add("foo", "bar") -> "foobar" -
write
Encode an output value into aDataOutput
.- Throws:
IOException
-
writeFinalOutput
Encode an final node output value into aDataOutput
. By default this just callswrite(Object, DataOutput)
.- Throws:
IOException
-
read
Decode an output value previously written withwrite(Object, DataOutput)
.- Throws:
IOException
-
skipOutput
Skip the output; defaults to just callingread(org.apache.lucene.store.DataInput)
and discarding the result.- Throws:
IOException
-
readFinalOutput
Decode an output value previously written withwriteFinalOutput(Object, DataOutput)
. By default this just callsread(DataInput)
.- Throws:
IOException
-
skipFinalOutput
Skip the output previously written withwriteFinalOutput(T, org.apache.lucene.store.DataOutput)
; defaults to just callingreadFinalOutput(org.apache.lucene.store.DataInput)
and discarding the result.- Throws:
IOException
-
getNoOutput
NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output -
outputToString
-
merge
-
ramBytesUsed
Return memory usage for the provided output.- See Also:
-