org.apache.lucene.util.fst

Class PositiveIntOutputs

java.lang.Object

org.apache.lucene.util.fst.Outputs<java.lang.Long>

org.apache.lucene.util.fst.PositiveIntOutputs

public final class PositiveIntOutputs
extends Outputs<java.lang.Long>

An FST Outputs implementation where each output is a non-negative long value.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.Long	NO_OUTPUT
private static PositiveIntOutputs	singleton

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PositiveIntOutputs()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	add(java.lang.Long prefix, java.lang.Long output) Eg add("foo", "bar") -> "foobar"
java.lang.Long	common(java.lang.Long output1, java.lang.Long output2) Eg common("foobar", "food") -> "foo"
java.lang.Long	getNoOutput() NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output
static PositiveIntOutputs	getSingleton()
java.lang.String	outputToString(java.lang.Long output)
long	ramBytesUsed(java.lang.Long output) Return memory usage for the provided output.
java.lang.Long	read(DataInput in) Decode an output value previously written with Outputs.write(Object, DataOutput).
java.lang.Long	subtract(java.lang.Long output, java.lang.Long inc) Eg subtract("foobar", "foo") -> "bar"
java.lang.String	toString()
private boolean	valid(java.lang.Long o)
void	write(java.lang.Long output, DataOutput out) Encode an output value into a DataOutput.

Methods inherited from class org.apache.lucene.util.fst.Outputs

merge, readFinalOutput, skipFinalOutput, skipOutput, writeFinalOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_OUTPUT

private static final java.lang.Long NO_OUTPUT

singleton

private static final PositiveIntOutputs singleton

Constructor Detail

PositiveIntOutputs

private PositiveIntOutputs()

Method Detail

getSingleton

public static PositiveIntOutputs getSingleton()

common

public java.lang.Long common(java.lang.Long output1,
                             java.lang.Long output2)

Description copied from class: Outputs

Eg common("foobar", "food") -> "foo"

Specified by:

common in class Outputs<java.lang.Long>

subtract

public java.lang.Long subtract(java.lang.Long output,
                               java.lang.Long inc)

Description copied from class: Outputs

Eg subtract("foobar", "foo") -> "bar"

Specified by:

subtract in class Outputs<java.lang.Long>

add

public java.lang.Long add(java.lang.Long prefix,
                          java.lang.Long output)

Description copied from class: Outputs

Eg add("foo", "bar") -> "foobar"

Specified by:

add in class Outputs<java.lang.Long>

write

public void write(java.lang.Long output,
                  DataOutput out)
           throws java.io.IOException

Description copied from class: Outputs

Encode an output value into a DataOutput.

Specified by:

write in class Outputs<java.lang.Long>

Throws:

java.io.IOException

read

public java.lang.Long read(DataInput in)
                    throws java.io.IOException

Description copied from class: Outputs

Decode an output value previously written with Outputs.write(Object, DataOutput).

Specified by:

read in class Outputs<java.lang.Long>

Throws:

java.io.IOException

valid

private boolean valid(java.lang.Long o)

getNoOutput

public java.lang.Long 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 class Outputs<java.lang.Long>

outputToString

public java.lang.String outputToString(java.lang.Long output)

Specified by:

outputToString in class Outputs<java.lang.Long>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

ramBytesUsed

public long ramBytesUsed(java.lang.Long output)

Description copied from class: Outputs

Return memory usage for the provided output.

Specified by:

ramBytesUsed in class Outputs<java.lang.Long>

See Also:

Accountable