Package org.apache.lucene.util.fst
Class ByteSequenceOutputs
- java.lang.Object
-
- org.apache.lucene.util.fst.Outputs<BytesRef>
-
- org.apache.lucene.util.fst.ByteSequenceOutputs
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BytesRefadd(BytesRef prefix, BytesRef output)Eg add("foo", "bar") -> "foobar"BytesRefcommon(BytesRef output1, BytesRef output2)Eg common("foobar", "food") -> "foo"BytesRefgetNoOutput()NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no outputstatic ByteSequenceOutputsgetSingleton()StringoutputToString(BytesRef output)longramBytesUsed(BytesRef output)Return memory usage for the provided output.BytesRefread(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.BytesRefsubtract(BytesRef output, BytesRef inc)Eg subtract("foobar", "foo") -> "bar"StringtoString()voidwrite(BytesRef prefix, DataOutput out)Encode an output value into aDataOutput.-
Methods inherited from class org.apache.lucene.util.fst.Outputs
merge, readFinalOutput, skipFinalOutput, writeFinalOutput
-
-
-
-
Method Detail
-
getSingleton
public static ByteSequenceOutputs getSingleton()
-
common
public BytesRef common(BytesRef output1, BytesRef output2)
Description copied from class:OutputsEg common("foobar", "food") -> "foo"
-
subtract
public BytesRef subtract(BytesRef output, BytesRef inc)
Description copied from class:OutputsEg subtract("foobar", "foo") -> "bar"
-
add
public BytesRef add(BytesRef prefix, BytesRef output)
Description copied from class:OutputsEg add("foo", "bar") -> "foobar"
-
write
public void write(BytesRef prefix, DataOutput out) throws IOException
Description copied from class:OutputsEncode an output value into aDataOutput.- Specified by:
writein classOutputs<BytesRef>- Throws:
IOException
-
read
public BytesRef read(DataInput in) throws IOException
Description copied from class:OutputsDecode an output value previously written withOutputs.write(Object, DataOutput).- Specified by:
readin classOutputs<BytesRef>- 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<BytesRef>- Throws:
IOException
-
getNoOutput
public BytesRef 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<BytesRef>
-
outputToString
public String outputToString(BytesRef output)
- Specified by:
outputToStringin classOutputs<BytesRef>
-
ramBytesUsed
public long ramBytesUsed(BytesRef output)
Description copied from class:OutputsReturn memory usage for the provided output.- Specified by:
ramBytesUsedin classOutputs<BytesRef>- See Also:
Accountable
-
-