built_value library

Classes

Builder<V extends Built<V, B>, B extends Builder<V, B>>
Every Built class has a corresponding Builder class.
Built<V extends Built<V, B>, B extends Builder<V, B>>
Implement this for a Built Value.
BuiltValue
Optionally, annotate a Built Value with this to specify settings. This is only needed for advanced use.
BuiltValueEnum
Optionally, annotate an EnumClass with this to specify settings. This is only needed for advanced use.
BuiltValueEnumConst
Optionally, annotate an EnumClass constant with this to specify settings. This is only needed for advanced use.
BuiltValueField
Optionally, annotate a Built Value field with this to specify settings. This is only needed for advanced use.
BuiltValueHook
Optionally, annotate methods with this to cause them to be called by generated code.
BuiltValueSerializer
Optionally, annotate a Built Value Serializer getters with this to specify settings. This is only needed for advanced use.
BuiltValueToStringHelper
Interface for built_value toString() output helpers.
EnumClass
Enum Class base class.
FlatBuiltValueToStringHelper
A BuiltValueToStringHelper that produces single line output.
IndentingBuiltValueToStringHelper
A BuiltValueToStringHelper that produces multi-line indented output.

Constants

memoized → const String
Memoized annotation for Built Value getters.
nullable → const String
Nullable annotation for nullable Built Value fields in legacy code.

Properties

newBuiltValueToStringHelper BuiltValueToStringHelperProvider
Function used by generated code to get a BuiltValueToStringHelper. Set this to change built_value class toString() output. Built-in examples are IndentingBuiltValueToStringHelper, which is the default, and FlatBuiltValueToStringHelper.
getter/setter pair

Functions

$jc(int hash, int value) int
For use by generated code in calculating hash codes. Do not use directly.
$jf(int hash) int
For use by generated code in calculating hash codes. Do not use directly.

Typedefs

BuiltValueToStringHelperProvider = BuiltValueToStringHelper Function(String className)
Function that returns a BuiltValueToStringHelper.

Exceptions / Errors

BuiltValueMissingGenericsError
Error indicating that a built_value class constructor was called with a missing or dynamic type parameter.
BuiltValueNestedFieldError
Error indicating that a built_value build method failed because a nested field builder failed.
BuiltValueNullFieldError
Error indicating that a built_value class constructor was called with a null value for a field not marked nullable.