com.facebook.buck.rules.coercer

Class DataTransferObjectDescriptor<T extends DataTransferObject>

java.lang.Object

com.facebook.buck.rules.coercer.DataTransferObjectDescriptor<T>

public abstract class DataTransferObjectDescriptor<T extends DataTransferObject>
extends Object

Class that contains the values needed to build a DescriptionArg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataTransferObjectDescriptor.BuilderBuildFailedException Checked exception thrown by DataTransferObjectDescriptor.BuilderBuildFunction when a user error (not internal error) occurs.
static interface	DataTransferObjectDescriptor.BuilderBuildFunction<T> A function to build a builder returned by getBuilderFactory()

Constructor Summary

Constructors

Constructor and Description
DataTransferObjectDescriptor()

Method Summary

Modifier and Type	Method and Description
T	build(Object builder, Object context) Builds the partially constructed object returned by getBuilderFactory()
abstract java.util.function.Supplier<Object>	getBuilderFactory() Get the builder for a constructor arg.
protected abstract DataTransferObjectDescriptor.BuilderBuildFunction<T>	getBuildFunction() A function that takes the result of getBuilderFactory()}, and calls its 'build' function to return description args of type T
abstract com.google.common.collect.ImmutableMap<String,ParamInfo<?>>	getParamInfos() The param infos needed to populate this object
abstract Class<T>	objectClass() Reified <T>
static <T extends DataTransferObject> DataTransferObjectDescriptor<T>	of(Class<T> objectClass, java.util.function.Supplier<Object> builderFactory, Map<String,? extends ParamInfo<?>> paramInfos, DataTransferObjectDescriptor.BuilderBuildFunction<T> buildFunction)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTransferObjectDescriptor

public DataTransferObjectDescriptor()

Method Detail

objectClass

public abstract Class<T> objectClass()

Reified <T>

getBuilderFactory

public abstract java.util.function.Supplier<Object> getBuilderFactory()

Get the builder for a constructor arg.

This is either the ImmutableValue.Builder class for T, or SkylarkDescriptionArg

getParamInfos

public abstract com.google.common.collect.ImmutableMap<String,ParamInfo<?>> getParamInfos()

The param infos needed to populate this object

getBuildFunction

protected abstract DataTransferObjectDescriptor.BuilderBuildFunction<T> getBuildFunction()

A function that takes the result of getBuilderFactory()}, and calls its 'build' function to return description args of type T

build

public T build(Object builder,
               Object context)

Builds the partially constructed object returned by getBuilderFactory()

Returns:

A fully constructed ConstructorArg of type T obtained by applying getBuildFunction() to getBuilderFactory()

of

public static <T extends DataTransferObject> DataTransferObjectDescriptor<T> of(Class<T> objectClass,
                                                                                java.util.function.Supplier<Object> builderFactory,
                                                                                Map<String,? extends ParamInfo<?>> paramInfos,
                                                                                DataTransferObjectDescriptor.BuilderBuildFunction<T> buildFunction)