Package org.apache.juneau.encoders

Class EncoderSet.Builder

java.lang.Object
org.apache.juneau.BeanBuilder<EncoderSet>
org.apache.juneau.encoders.EncoderSet.Builder
Enclosing class:
EncoderSet
public static class EncoderSet.Builder extends BeanBuilder<EncoderSet>
Builder class.

  • Constructor Details

    • Builder

      protected Builder(BeanStore beanStore)
      Constructor.
      Parameters:
      beanStore - The bean store to use for creating beans.

    • Builder

      protected Builder(EncoderSet.Builder copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The builder being copied.

  • Method Details

    • add

      public EncoderSet.Builder add(Class<?>... values)
      Registers the specified encoders with this group.

      Entries are added in-order to the beginning of the list.

      Parameters:
      values - The encoders to add to this group.
      Returns:
      This object.
      Throws:
      IllegalArgumentException - if any class does not extend from Encoder.

    • add

      public EncoderSet.Builder add(Encoder... values)
      Registers the specified encoders with this group.

      Entries are added to the beginning of the list.

      Parameters:
      values - The encoders to add to this group.
      Returns:
      This object.

    • clear

      public EncoderSet.Builder clear()
      Clears out any existing encoders in this group.
      Returns:
      This object.

    • copy

      public EncoderSet.Builder copy()
      Makes a copy of this builder.
      Returns:
      A new copy of this builder.

    • impl

      public EncoderSet.Builder impl(Object value)
      Description copied from class: BeanBuilder
      Overrides the bean returned by the BeanBuilder.build() method.

      Use this method if you want this builder to return an already-instantiated bean.

      Overrides:
      impl in class BeanBuilder<EncoderSet>
      Parameters:
      value - The setting value.
      Returns:
      This object.

    • inner

      public List<Object> inner()
      Returns direct access to the Encoder objects and classes in this builder.

      Provided to allow for any extraneous modifications to the list not accomplishable via other methods on this builder such as re-ordering/adding/removing entries.

      Note that it is up to the user to ensure that the list only contains Encoder objects and classes.

      Returns:
      The inner list of entries in this builder.

    • isEmpty

      public boolean isEmpty()
      Returns true if this builder is empty.
      Returns:
      true if this builder is empty.

    • set

      public EncoderSet.Builder set(Class<?>... values)
      Sets the encoders in this group.

      All encoders in this group are replaced with the specified values.

      If EncoderSet.Inherit is specified (or any other class whose simple name is "Inherit", the existing values are preserved and inserted into the position in the values array.

      Parameters:
      values - The encoders to add to this group.
      Returns:
      This object.
      Throws:
      IllegalArgumentException - if any class does not extend from Encoder.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • type

      public EncoderSet.Builder type(Class<?> value)
      Description copied from class: BeanBuilder
      Overrides the bean type produced by the BeanBuilder.build() method.

      Use this method if you want to instantiated a bean subclass.

      Overrides:
      type in class BeanBuilder<EncoderSet>
      Parameters:
      value - The setting value.
      Returns:
      This object.

    • buildDefault

      protected EncoderSet buildDefault()
      Description copied from class: BeanBuilder
      Creates the bean when the bean type is null or is the default value.
      Overrides:
      buildDefault in class BeanBuilder<EncoderSet>
      Returns:
      A new bean.