Package org.apache.lucene.util.fst
Class PairOutputs<A,B>
java.lang.Object
org.apache.lucene.util.fst.Outputs<PairOutputs.Pair<A,B>>
org.apache.lucene.util.fst.PairOutputs<A,B>
An FST
Outputs
implementation, holding two other outputs.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Holds a single pair of two outputs. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadd
(PairOutputs.Pair<A, B> prefix, PairOutputs.Pair<A, B> output) Eg add("foo", "bar") -> "foobar"common
(PairOutputs.Pair<A, B> pair1, PairOutputs.Pair<A, B> pair2) Eg common("foobar", "food") -> "foo"NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no outputCreate a new PairoutputToString
(PairOutputs.Pair<A, B> output) long
ramBytesUsed
(PairOutputs.Pair<A, B> output) Return memory usage for the provided output.Decode an output value previously written withOutputs.write(Object, DataOutput)
.void
skipOutput
(DataInput in) Skip the output; defaults to just callingOutputs.read(org.apache.lucene.store.DataInput)
and discarding the result.subtract
(PairOutputs.Pair<A, B> output, PairOutputs.Pair<A, B> inc) Eg subtract("foobar", "foo") -> "bar"toString()
void
write
(PairOutputs.Pair<A, B> output, DataOutput writer) Encode an output value into aDataOutput
.Methods inherited from class org.apache.lucene.util.fst.Outputs
merge, readFinalOutput, skipFinalOutput, writeFinalOutput
-
Constructor Details
-
PairOutputs
-
-
Method Details
-
newPair
Create a new Pair -
common
Description copied from class:Outputs
Eg common("foobar", "food") -> "foo"- Specified by:
common
in classOutputs<PairOutputs.Pair<A,
B>>
-
subtract
Description copied from class:Outputs
Eg subtract("foobar", "foo") -> "bar"- Specified by:
subtract
in classOutputs<PairOutputs.Pair<A,
B>>
-
add
Description copied from class:Outputs
Eg add("foo", "bar") -> "foobar"- Specified by:
add
in classOutputs<PairOutputs.Pair<A,
B>>
-
write
Description copied from class:Outputs
Encode an output value into aDataOutput
.- Specified by:
write
in classOutputs<PairOutputs.Pair<A,
B>> - Throws:
IOException
-
read
Description copied from class:Outputs
Decode an output value previously written withOutputs.write(Object, DataOutput)
.- Specified by:
read
in classOutputs<PairOutputs.Pair<A,
B>> - Throws:
IOException
-
skipOutput
Description copied from class:Outputs
Skip the output; defaults to just callingOutputs.read(org.apache.lucene.store.DataInput)
and discarding the result.- Overrides:
skipOutput
in classOutputs<PairOutputs.Pair<A,
B>> - Throws:
IOException
-
getNoOutput
Description copied from class:Outputs
NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output- Specified by:
getNoOutput
in classOutputs<PairOutputs.Pair<A,
B>>
-
outputToString
- Specified by:
outputToString
in classOutputs<PairOutputs.Pair<A,
B>>
-
toString
-
ramBytesUsed
Description copied from class:Outputs
Return memory usage for the provided output.- Specified by:
ramBytesUsed
in classOutputs<PairOutputs.Pair<A,
B>> - See Also:
-