com.cinchapi.concourse

Class Tag

Object

Tag

All Implemented Interfaces:

Comparable<Tag>

@Immutable
public final class Tag
extends Object
implements Comparable<Tag>

A Tag is a String data type that does not get indexed for full text search.

Each Tag is equivalent to its String counterpart (e.g. Tag.create("foo").equals(new String("foo")) is true. Tags merely exist for the client to instruct Concourse not to perform full text indexing on the data. Within Concourse, Tags are stored on disk as strings. So, any value that is written as a Tag is always returned as a String when read from Concourse.

Field Summary

Fields

Modifier and Type	Field and Description
static Tag	EMPTY_TAG A singleton Tag that represents the empty string.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Tag other)
static Tag	create(String value) Return a Tag that embeds value.
boolean	equals(Object other) Return true if other of type String or Tag equals this Tag.
String	toString() Return the String value that this Tag embeds.

Methods inherited from class Object

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

Field Detail

EMPTY_TAG

public static final Tag EMPTY_TAG

A singleton Tag that represents the empty string.

Method Detail

create

public static Tag create(String value)

Return a Tag that embeds value.

Parameters:

value -

Returns:

the Tag

compareTo

public int compareTo(Tag other)

Specified by:

compareTo in interface Comparable<Tag>

equals

public boolean equals(Object other)

Return true if other of type String or Tag equals this Tag.

Overrides:

equals in class Object

Parameters:

other -

Returns:

true if other equals this tag

toString

public String toString()

Return the String value that this Tag embeds.

Overrides:

toString in class Object

Returns:

the value