Package org.immutables.value.processor.encode

Class ImmutableEncodingInfo.Builder

java.lang.Object
org.immutables.value.processor.encode.ImmutableEncodingInfo.Builder
Direct Known Subclasses:
EncodingInfo.Builder
Enclosing class:
ImmutableEncodingInfo
@NotThreadSafe public static class ImmutableEncodingInfo.Builder extends Object
Builds instances of type EncodingInfo. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

  • Field Details

  • Constructor Details

    • Builder

      public Builder()
      Creates a builder for EncodingInfo instances. 
       new EncodingInfo.Builder()
    .name(String) // required name
    .addImports|addAllImports(String) // imports elements
    .typeParameters(org.immutables.value.processor.encode.Type.Parameters) // required typeParameters
    .typeFactory(org.immutables.value.processor.encode.Type.Factory) // required typeFactory
    .addElement|addAllElement(org.immutables.value.processor.encode.EncodedElement) // element elements
    .build();

  • Method Details

    • name

      public final EncodingInfo.Builder name(String name)
      Initializes the value for the name attribute.
      Parameters:
      name - The value for name
      Returns:
      this builder for use in a chained invocation

    • addImports

      public final EncodingInfo.Builder addImports(String element)
      Adds one element to imports set.
      Parameters:
      element - A imports element
      Returns:
      this builder for use in a chained invocation

    • addImports

      public final EncodingInfo.Builder addImports(String... elements)
      Adds elements to imports set.
      Parameters:
      elements - An array of imports elements
      Returns:
      this builder for use in a chained invocation

    • addAllImports

      public final EncodingInfo.Builder addAllImports(Iterable<String> elements)
      Adds elements to imports set.
      Parameters:
      elements - An iterable of imports elements
      Returns:
      this builder for use in a chained invocation

    • typeParameters

      public final EncodingInfo.Builder typeParameters(Type.Parameters typeParameters)
      Initializes the value for the typeParameters attribute.
      Parameters:
      typeParameters - The value for typeParameters
      Returns:
      this builder for use in a chained invocation

    • typeFactory

      public final EncodingInfo.Builder typeFactory(Type.Factory typeFactory)
      Initializes the value for the typeFactory attribute.
      Parameters:
      typeFactory - The value for typeFactory
      Returns:
      this builder for use in a chained invocation

    • addElement

      public final EncodingInfo.Builder addElement(EncodedElement element)
      Adds one element to element list.
      Parameters:
      element - A element element
      Returns:
      this builder for use in a chained invocation

    • addElement

      public final EncodingInfo.Builder addElement(EncodedElement... elements)
      Adds elements to element list.
      Parameters:
      elements - An array of element elements
      Returns:
      this builder for use in a chained invocation

    • addAllElement

      public final EncodingInfo.Builder addAllElement(Iterable<? extends EncodedElement> elements)
      Adds elements to element list.
      Parameters:
      elements - An iterable of element elements
      Returns:
      this builder for use in a chained invocation

    • build

      public EncodingInfo build()
      Builds a new EncodingInfo.
      Returns:
      An immutable instance of EncodingInfo
      Throws:
      IllegalStateException - if any required attributes are missing

    • nameIsSet

      private boolean nameIsSet()

    • typeParametersIsSet

      private boolean typeParametersIsSet()

    • typeFactoryIsSet

      private boolean typeFactoryIsSet()

    • checkNotIsSet

      private static void checkNotIsSet(boolean isSet, String name)

    • checkRequiredAttributes

      private void checkRequiredAttributes()

    • formatRequiredAttributesMessage

      private String formatRequiredAttributesMessage()