com.facebook.buck.core.artifact

Class SourceArtifactImpl

java.lang.Object

com.facebook.buck.core.artifact.SourceArtifactImpl

All Implemented Interfaces:

Artifact, BoundArtifact, SourceArtifact, AddsToRuleKey, SkylarkArtifactApi, com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable, com.google.devtools.build.lib.skylarkinterface.SkylarkValue, Comparable<Artifact>

public abstract class SourceArtifactImpl
extends Object
implements SourceArtifact, BoundArtifact

An artifact representing a source file

Constructor Summary

Constructors

Constructor and Description
SourceArtifactImpl()

Method Summary

Modifier and Type	Method and Description
BoundArtifact	asBound()
BuildArtifact	asBuildArtifact()
com.facebook.buck.core.artifact.DeclaredArtifact	asDeclared()
OutputArtifact	asOutputArtifact()
SkylarkOutputArtifactApi	asSkylarkOutputArtifact(com.google.devtools.build.lib.events.Location location)
SourceArtifact	asSource()
int	compareTo(Artifact artifact)
String	getBasename()
String	getExtension()
Object	getOwner()
Optional<com.google.devtools.build.lib.cmdline.Label>	getOwnerTyped()
String	getShortPath()
abstract PathSourcePath	getSourcePath()
boolean	isBound()
boolean	isSource()
static SourceArtifactImpl	of(PathSourcePath sourcePath)
void	repr(com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter printer)
protected void	requireBound()
protected void	requireDeclared()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.core.artifact.Artifact

asBound, asDeclared

Methods inherited from interface com.facebook.buck.core.starlark.rule.artifact.SkylarkArtifactApi

getOwner, isImmutable

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkValue

isHashable

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable

debugPrint, str

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

SourceArtifactImpl

public SourceArtifactImpl()

Method Detail

isBound

public final boolean isBound()

Specified by:

isBound in interface Artifact

Returns:

whether the artifact is bound, as described above

getSourcePath

public abstract PathSourcePath getSourcePath()

Specified by:

getSourcePath in interface BoundArtifact

Specified by:

getSourcePath in interface SourceArtifact

Returns:

the path to the source file

asSource

@Nullable
public SourceArtifact asSource()

Specified by:

asSource in interface BoundArtifact

Returns:

this artifact as a SourceArtifact, null if this is not a SourceArtifact

asBuildArtifact

@Nullable
public BuildArtifact asBuildArtifact()

Specified by:

asBuildArtifact in interface BoundArtifact

Returns:

this artifact as a BuildArtifact, null if this is not a BuildArtifact

getBasename

@Value.Lazy
public String getBasename()

Specified by:

getBasename in interface SkylarkArtifactApi

getExtension

@Value.Lazy
public String getExtension()

Specified by:

getExtension in interface SkylarkArtifactApi

getOwnerTyped

@Value.Lazy
public Optional<com.google.devtools.build.lib.cmdline.Label> getOwnerTyped()

Returns:

The Label of the rule that created this artifact, or Optional.empty() if not applicable. This is converted to a Skylark appropriate type by getOwner()

isSource

@Value.Lazy
public boolean isSource()

Specified by:

isSource in interface SkylarkArtifactApi

getShortPath

@Value.Lazy
public String getShortPath()

Specified by:

getShortPath in interface SkylarkArtifactApi

repr

public void repr(com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter printer)

Specified by:

repr in interface com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable

asSkylarkOutputArtifact

public SkylarkOutputArtifactApi asSkylarkOutputArtifact(com.google.devtools.build.lib.events.Location location)
                                                 throws com.google.devtools.build.lib.syntax.EvalException

Specified by:

asSkylarkOutputArtifact in interface SkylarkArtifactApi

Throws:

com.google.devtools.build.lib.syntax.EvalException

asOutputArtifact

public OutputArtifact asOutputArtifact()

Specified by:

asOutputArtifact in interface Artifact

Returns:

get this artifact as an OutputArtifact. Throws if cannot be converted

of

public static SourceArtifactImpl of(PathSourcePath sourcePath)

asBound

public final BoundArtifact asBound()

Specified by:

asBound in interface Artifact

Returns:

a view of this artifact as a BoundArtifact

asDeclared

public final com.facebook.buck.core.artifact.DeclaredArtifact asDeclared()

Specified by:

asDeclared in interface Artifact

Returns:

a view of this artifact as a DeclaredArtifact

requireBound

protected void requireBound()

requireDeclared

protected void requireDeclared()

getOwner

public final Object getOwner()

Specified by:

getOwner in interface SkylarkArtifactApi

compareTo

public final int compareTo(Artifact artifact)

Specified by:

compareTo in interface Comparable<Artifact>