com.facebook.buck.rules.coercer

Interface TypeCoercer<U,T>

Type Parameters:

T - resulting type

U - input type

All Superinterfaces:

Concatable<T>

All Known Implementing Classes:

BuildConfigFieldsTypeCoercer, BuildTargetTypeCoercer, BuildTargetWithOutputsTypeCoercer, CollectionTypeCoercer, ConstraintTypeCoercer, CxxLinkGroupMappingCoercer, CxxLinkGroupMappingTargetCoercer, CxxLinkGroupMappingTargetTraversalCoercer, EitherTypeCoercer, EnumTypeCoercer, FlavorTypeCoercer, FrameworkPathTypeCoercer, IdentityTypeCoercer, ImmutableTypeCoercer, LeafTypeCoercer, LeafTypeNewCoercer, LeafUnconfiguredOnlyCoercer, ListTypeCoercer, LogLevelTypeCoercer, ManifestEntriesTypeCoercer, MapTypeCoercer, NeededCoverageSpecTypeCoercer, NumberTypeCoercer, OptionalTypeCoercer, PairTypeCoercer, PathTypeCoercer, PatternMatchedCollectionTypeCoercer, PatternTypeCoercer, QueryCoercer, SetTypeCoercer, SortedMapTypeCoercer, SortedSetTypeCoercer, SourcePathTypeCoercer, SourceSetTypeCoercer, SourceSortedSetTypeCoercer, SourceWithFlagsListTypeCoercer, SourceWithFlagsTypeCoercer, StringTypeCoercer, StringWithMacrosTypeCoercer, TestRunnerSpecCoercer, UnconfiguredBuildTargetTypeCoercer, UnconfiguredBuildTargetWithOutputsTypeCoercer, VersionMatchedCollectionTypeCoercer

public interface TypeCoercer<U,T>
extends Concatable<T>

Class defining an interpretation of some dynamically typed Java object as a specific class.

Used to coerce JSON parser output from BUCK files into the proper type to populate Description rule args.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TypeCoercer.Traversal

Method Summary

Modifier and Type	Method and Description
default <S> TypeCoercer<U,S>	checkOutputAssignableTo(com.google.common.reflect.TypeToken<S> type) Runtime checked cast.
default <S> TypeCoercer<S,T>	checkUnconfiguredAssignableTo(com.google.common.reflect.TypeToken<S> type) Runtime checked cast.
T	coerce(CellNameResolver cellRoots, ProjectFilesystem filesystem, ForwardRelativePath pathRelativeToProjectRoot, TargetConfiguration targetConfiguration, TargetConfiguration hostConfiguration, U object)
default T	coerceBoth(CellNameResolver cellRoots, ProjectFilesystem filesystem, ForwardRelativePath pathRelativeToProjectRoot, TargetConfiguration targetConfiguration, TargetConfiguration hostConfiguration, Object object) Apply coerceToUnconfigured(CellNameResolver, ProjectFilesystem, ForwardRelativePath, Object) followed by coerce(CellNameResolver, ProjectFilesystem, ForwardRelativePath, TargetConfiguration, TargetConfiguration, Object).
U	coerceToUnconfigured(CellNameResolver cellRoots, ProjectFilesystem filesystem, ForwardRelativePath pathRelativeToProjectRoot, Object object) Coerce to a value for unconfigured graph.
default T	concat(Iterable<T> elements) Implementation of concatenation for this type.
com.google.common.reflect.TypeToken<T>	getOutputType()
com.google.common.reflect.TypeToken<U>	getUnconfiguredType()
boolean	hasElementClass(Class<?>... types) Returns whether the leaf nodes of this type coercer outputs value that is an instance of the given class or its subclasses.
default boolean	supportsConcatenation()
void	traverse(CellNameResolver cellRoots, T object, TypeCoercer.Traversal traversal) Traverse an object guided by this TypeCoercer.
default boolean	unconfiguredToConfiguredCoercionIsIdentity() coerce(CellNameResolver, ProjectFilesystem, ForwardRelativePath, TargetConfiguration, TargetConfiguration, Object) must be no-op when this returns true.

Method Detail

getOutputType

com.google.common.reflect.TypeToken<T> getOutputType()

getUnconfiguredType

com.google.common.reflect.TypeToken<U> getUnconfiguredType()

unconfiguredToConfiguredCoercionIsIdentity

default boolean unconfiguredToConfiguredCoercionIsIdentity()

coerce(CellNameResolver, ProjectFilesystem, ForwardRelativePath, TargetConfiguration, TargetConfiguration, Object) must be no-op when this returns true.

hasElementClass

boolean hasElementClass(Class<?>... types)

Returns whether the leaf nodes of this type coercer outputs value that is an instance of the given class or its subclasses. Does not match non-leaf nodes like Map or List.

traverse

void traverse(CellNameResolver cellRoots,
              T object,
              TypeCoercer.Traversal traversal)

Traverse an object guided by this TypeCoercer.

#{link Traversal#traverse} function will be called once for the object. If the object is a collection or map, it will also recursively traverse all elements of the map.

coerceToUnconfigured

U coerceToUnconfigured(CellNameResolver cellRoots,
                       ProjectFilesystem filesystem,
                       ForwardRelativePath pathRelativeToProjectRoot,
                       Object object)
                throws CoerceFailedException

Coerce to a value for unconfigured graph.

Throws:

CoerceFailedException

coerce

T coerce(CellNameResolver cellRoots,
         ProjectFilesystem filesystem,
         ForwardRelativePath pathRelativeToProjectRoot,
         TargetConfiguration targetConfiguration,
         TargetConfiguration hostConfiguration,
         U object)
  throws CoerceFailedException

Throws:

CoerceFailedException - Input object cannot be coerced into the given type.

coerceBoth

default T coerceBoth(CellNameResolver cellRoots,
                     ProjectFilesystem filesystem,
                     ForwardRelativePath pathRelativeToProjectRoot,
                     TargetConfiguration targetConfiguration,
                     TargetConfiguration hostConfiguration,
                     Object object)
              throws CoerceFailedException

Apply coerceToUnconfigured(CellNameResolver, ProjectFilesystem, ForwardRelativePath, Object) followed by coerce(CellNameResolver, ProjectFilesystem, ForwardRelativePath, TargetConfiguration, TargetConfiguration, Object).

Throws:

CoerceFailedException

concat

@Nullable
default T concat(Iterable<T> elements)

Implementation of concatenation for this type. null indicates that concatenation isn't supported by the type.

Specified by:

concat in interface Concatable<T>

Returns:

an instance with concatenated elements or null if concatenation is not supported for the type

supportsConcatenation

default boolean supportsConcatenation()

Returns:

true is this coercer supports concatenation.

checkOutputAssignableTo

default <S> TypeCoercer<U,S> checkOutputAssignableTo(com.google.common.reflect.TypeToken<S> type)

Runtime checked cast.

checkUnconfiguredAssignableTo

default <S> TypeCoercer<S,T> checkUnconfiguredAssignableTo(com.google.common.reflect.TypeToken<S> type)

Runtime checked cast.