com.facebook.buck.core.cell.name

Class CanonicalCellName

java.lang.Object

com.facebook.buck.core.cell.name.CanonicalCellName

All Implemented Interfaces:

Comparable<CanonicalCellName>

@Value.Immutable(prehash=true,
                 builder=false,
                 copy=false,
                 intern=true)
public abstract class CanonicalCellName
extends Object
implements Comparable<CanonicalCellName>

Provides a canonical identifier for a Cell. There is a 1-1 mapping between these.

These should not be constructed by users and instead should only be acquired from a Cell or via a CellNameResolver.

Constructor Summary

Constructors

Constructor and Description
CanonicalCellName()

Method Summary

Modifier and Type	Method and Description
int	compareTo(CanonicalCellName o)
abstract Optional<String>	getLegacyName() Returns the underlying name in the legacy Optional<String> format.
String	getName() Returns the name in a human-readable form.
static CanonicalCellName	of(Optional<String> name)
static CanonicalCellName	rootCell()
String	toString()
static CanonicalCellName	unsafeNotACell() This cell object is used when there's no cell, but CanonicalCellName object is needed.
static CanonicalCellName	unsafeOf(Optional<String> name) Used for creating CanonicalCellName in places where we aren't guaranteed to be handling canonicalization correctly.
static CanonicalCellName	unsafeRootCell() This should be used to mark places that are hardcoding the root cell's canonical name in a way that doesn't ensure that it's correct.

Methods inherited from class java.lang.Object

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

Constructor Detail

CanonicalCellName

public CanonicalCellName()

Method Detail

rootCell

public static CanonicalCellName rootCell()

unsafeNotACell

public static CanonicalCellName unsafeNotACell()

This cell object is used when there's no cell, but CanonicalCellName object is needed. This cell name is never resolved successfully to a cell.

unsafeRootCell

public static CanonicalCellName unsafeRootCell()

This should be used to mark places that are hardcoding the root cell's canonical name in a way that doesn't ensure that it's correct.

getLegacyName

public abstract Optional<String> getLegacyName()

Returns the underlying name in the legacy Optional<String> format.

getName

public String getName()

Returns the name in a human-readable form.

compareTo

public int compareTo(CanonicalCellName o)

Specified by:

compareTo in interface Comparable<CanonicalCellName>

toString

public String toString()

Overrides:

toString in class Object

of

public static CanonicalCellName of(Optional<String> name)

unsafeOf

public static CanonicalCellName unsafeOf(Optional<String> name)

Used for creating CanonicalCellName in places where we aren't guaranteed to be handling canonicalization correctly. This is only used to mark those places so that they are easier to find, the behavior is unchanged.