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>
-
public class PairOutputs<A,B> extends Outputs<PairOutputs.Pair<A,B>>
An FSTOutputsimplementation, holding two other outputs.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPairOutputs.Pair<A,B>Holds a single pair of two outputs.
-
Constructor Summary
Constructors Constructor Description PairOutputs(Outputs<A> outputs1, Outputs<B> outputs2)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PairOutputs.Pair<A,B>add(PairOutputs.Pair<A,B> prefix, PairOutputs.Pair<A,B> output)Eg add("foo", "bar") -> "foobar"PairOutputs.Pair<A,B>common(PairOutputs.Pair<A,B> pair1, PairOutputs.Pair<A,B> pair2)Eg common("foobar", "food") -> "foo"PairOutputs.Pair<A,B>getNoOutput()NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no outputPairOutputs.Pair<A,B>newPair(A a, B b)Create a new PairStringoutputToString(PairOutputs.Pair<A,B> output)longramBytesUsed(PairOutputs.Pair<A,B> output)Return memory usage for the provided output.PairOutputs.Pair<A,B>read(DataInput in)Decode an output value previously written withOutputs.write(Object, DataOutput).voidskipOutput(DataInput in)Skip the output; defaults to just callingOutputs.read(org.apache.lucene.store.DataInput)and discarding the result.PairOutputs.Pair<A,B>subtract(PairOutputs.Pair<A,B> output, PairOutputs.Pair<A,B> inc)Eg subtract("foobar", "foo") -> "bar"StringtoString()voidwrite(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
-
-
-
-
Method Detail
-
newPair
public PairOutputs.Pair<A,B> newPair(A a, B b)
Create a new Pair
-
common
public PairOutputs.Pair<A,B> common(PairOutputs.Pair<A,B> pair1, PairOutputs.Pair<A,B> pair2)
Description copied from class:OutputsEg common("foobar", "food") -> "foo"- Specified by:
commonin classOutputs<PairOutputs.Pair<A,B>>
-
subtract
public PairOutputs.Pair<A,B> subtract(PairOutputs.Pair<A,B> output, PairOutputs.Pair<A,B> inc)
Description copied from class:OutputsEg subtract("foobar", "foo") -> "bar"- Specified by:
subtractin classOutputs<PairOutputs.Pair<A,B>>
-
add
public PairOutputs.Pair<A,B> add(PairOutputs.Pair<A,B> prefix, PairOutputs.Pair<A,B> output)
Description copied from class:OutputsEg add("foo", "bar") -> "foobar"- Specified by:
addin classOutputs<PairOutputs.Pair<A,B>>
-
write
public void write(PairOutputs.Pair<A,B> output, DataOutput writer) throws IOException
Description copied from class:OutputsEncode an output value into aDataOutput.- Specified by:
writein classOutputs<PairOutputs.Pair<A,B>>- Throws:
IOException
-
read
public PairOutputs.Pair<A,B> read(DataInput in) throws IOException
Description copied from class:OutputsDecode an output value previously written withOutputs.write(Object, DataOutput).- Specified by:
readin classOutputs<PairOutputs.Pair<A,B>>- Throws:
IOException
-
skipOutput
public void skipOutput(DataInput in) throws IOException
Description copied from class:OutputsSkip the output; defaults to just callingOutputs.read(org.apache.lucene.store.DataInput)and discarding the result.- Overrides:
skipOutputin classOutputs<PairOutputs.Pair<A,B>>- Throws:
IOException
-
getNoOutput
public PairOutputs.Pair<A,B> getNoOutput()
Description copied from class:OutputsNOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output- Specified by:
getNoOutputin classOutputs<PairOutputs.Pair<A,B>>
-
outputToString
public String outputToString(PairOutputs.Pair<A,B> output)
- Specified by:
outputToStringin classOutputs<PairOutputs.Pair<A,B>>
-
ramBytesUsed
public long ramBytesUsed(PairOutputs.Pair<A,B> output)
Description copied from class:OutputsReturn memory usage for the provided output.- Specified by:
ramBytesUsedin classOutputs<PairOutputs.Pair<A,B>>- See Also:
Accountable
-
-