com.facebook.buck.rules.coercer

Class MapTypeCoercer<KU,VU,K,V>

java.lang.Object

com.facebook.buck.rules.coercer.MapTypeCoercer<KU,VU,K,V>

All Implemented Interfaces:

Concatable<com.google.common.collect.ImmutableMap<K,V>>, TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

public class MapTypeCoercer<KU,VU,K,V>
extends Object
implements TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

Coerce to ImmutableMap.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.rules.coercer.TypeCoercer

TypeCoercer.Traversal

Constructor Summary

Constructors

Constructor and Description
MapTypeCoercer(TypeCoercer<KU,K> keyTypeCoercer, TypeCoercer<VU,V> valueTypeCoercer)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<K,V>	coerce(CellNameResolver cellRoots, ProjectFilesystem filesystem, ForwardRelativePath pathRelativeToProjectRoot, TargetConfiguration targetConfiguration, TargetConfiguration hostConfiguration, com.google.common.collect.ImmutableMap<KU,VU> object)
com.google.common.collect.ImmutableMap<KU,VU>	coerceToUnconfigured(CellNameResolver cellRoots, ProjectFilesystem filesystem, ForwardRelativePath pathRelativeToProjectRoot, Object object) Coerce to a value for unconfigured graph.
com.google.common.collect.ImmutableMap<K,V>	concat(Iterable<com.google.common.collect.ImmutableMap<K,V>> elements) Implementation of concatenation for this type.
com.google.common.reflect.TypeToken<com.google.common.collect.ImmutableMap<K,V>>	getOutputType()
com.google.common.reflect.TypeToken<com.google.common.collect.ImmutableMap<KU,VU>>	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.
void	traverse(CellNameResolver cellRoots, com.google.common.collect.ImmutableMap<K,V> object, TypeCoercer.Traversal traversal) Traverse an object guided by this TypeCoercer.
boolean	unconfiguredToConfiguredCoercionIsIdentity() TypeCoercer.coerce(CellNameResolver, ProjectFilesystem, ForwardRelativePath, TargetConfiguration, TargetConfiguration, Object) must be no-op when this returns true.

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.rules.coercer.TypeCoercer

checkOutputAssignableTo, checkUnconfiguredAssignableTo, coerceBoth, supportsConcatenation

Constructor Detail

MapTypeCoercer

public MapTypeCoercer(TypeCoercer<KU,K> keyTypeCoercer,
                      TypeCoercer<VU,V> valueTypeCoercer)

Method Detail

getOutputType

public com.google.common.reflect.TypeToken<com.google.common.collect.ImmutableMap<K,V>> getOutputType()

Specified by:

getOutputType in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

getUnconfiguredType

public com.google.common.reflect.TypeToken<com.google.common.collect.ImmutableMap<KU,VU>> getUnconfiguredType()

Specified by:

getUnconfiguredType in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

hasElementClass

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

Description copied from interface: TypeCoercer

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.

Specified by:

hasElementClass in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

traverse

public void traverse(CellNameResolver cellRoots,
                     com.google.common.collect.ImmutableMap<K,V> object,
                     TypeCoercer.Traversal traversal)

Description copied from interface: TypeCoercer

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.

Specified by:

traverse in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

coerceToUnconfigured

public com.google.common.collect.ImmutableMap<KU,VU> coerceToUnconfigured(CellNameResolver cellRoots,
                                                                          ProjectFilesystem filesystem,
                                                                          ForwardRelativePath pathRelativeToProjectRoot,
                                                                          Object object)
                                                                   throws CoerceFailedException

Description copied from interface: TypeCoercer

Coerce to a value for unconfigured graph.

Specified by:

coerceToUnconfigured in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

Throws:

CoerceFailedException

unconfiguredToConfiguredCoercionIsIdentity

public boolean unconfiguredToConfiguredCoercionIsIdentity()

Description copied from interface: TypeCoercer

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

Specified by:

unconfiguredToConfiguredCoercionIsIdentity in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

coerce

public com.google.common.collect.ImmutableMap<K,V> coerce(CellNameResolver cellRoots,
                                                          ProjectFilesystem filesystem,
                                                          ForwardRelativePath pathRelativeToProjectRoot,
                                                          TargetConfiguration targetConfiguration,
                                                          TargetConfiguration hostConfiguration,
                                                          com.google.common.collect.ImmutableMap<KU,VU> object)
                                                   throws CoerceFailedException

Specified by:

coerce in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

Throws:

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

concat

@Nullable
public com.google.common.collect.ImmutableMap<K,V> concat(Iterable<com.google.common.collect.ImmutableMap<K,V>> elements)

Description copied from interface: TypeCoercer

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

Specified by:

concat in interface Concatable<com.google.common.collect.ImmutableMap<K,V>>

Specified by:

concat in interface TypeCoercer<com.google.common.collect.ImmutableMap<KU,VU>,com.google.common.collect.ImmutableMap<K,V>>

Returns:

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