Package org.apache.juneau.marshall.serializer

Class SerializerSet.Builder

java.lang.Object
org.apache.juneau.marshall.serializer.SerializerSet.Builder
All Implemented Interfaces:
BeanStoreOverridable<SerializerSet.Builder>
Enclosing class:
SerializerSet
public static class SerializerSet.Builder extends Object implements BeanStoreOverridable<SerializerSet.Builder>
Builder class.

  • Constructor Details

    • Builder

      protected Builder(BeanStore beanStore)
      Create an empty serializer group builder.
      Parameters:
      beanStore - The bean store to use for creating beans.

    • Builder

      protected Builder(SerializerSet.Builder copyFrom)
      Clone an existing serializer group builder.

      Serializer builders will be cloned during this process.

      Parameters:
      copyFrom - The serializer group that we're copying settings and serializers from.
      Cannot be null.

    • Builder

      protected Builder(SerializerSet copyFrom)
      Clone an existing serializer group.
      Parameters:
      copyFrom - The serializer group that we're copying settings and serializers from.
      Cannot be null.

  • Method Details

    • beanStore

      public BeanStore beanStore()
      Returns the bean store used by this builder.
      Returns:
      The bean store used by this builder.

    • overridingBeanStore

      public SerializerSet.Builder overridingBeanStore(BeanStore store)
      Installs the supplied BeanStore as the overridingParent of this builder's bean store.

      Wraps the current beanStore() in a fresh BasicBeanStore whose overridingParent is the supplied store, so test-time overrides win over the builder's regular bean lookups during construction-time reflective injection. Passing null is a no-op.

      Specified by:
      overridingBeanStore in interface BeanStoreOverridable<SerializerSet.Builder>
      Parameters:
      store - The override layer. Can be null (no-op).
      Returns:
      This object.
      Since:
      10.0.0

    • add

      public SerializerSet.Builder add(Class<?>... values)
      Adds the specified serializers to this group.

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

      The SerializerSet.NoInherit class can be used to clear out the existing list of serializers before adding the new entries.

      Example:

      SerializerSet.Builder builder = SerializerSet.create(); // Create an empty builder. builder.add(FooSerializer.class); // Now contains: [FooSerializer] builder.add(BarSerializer.class, BazSerializer.class); // Now contains: [BarParser,BazSerializer,FooSerializer] builder.add(NoInherit.class, QuxSerializer.class); // Now contains: [QuxSerializer]

      Parameters:
      values - The serializers to add to this group.
      Returns:
      This object.
      Throws:
      IllegalArgumentException - If one or more values do not extend from Serializer.

    • add

      public SerializerSet.Builder add(Serializer... s)
      Registers the specified serializers with this group.

      When passing in pre-instantiated serializers to this group, applying properties and transforms to the group do not affect them.

      Parameters:
      s - The serializers to append to this group.
      Returns:
      This object.

    • apply

      public SerializerSet.Builder apply(AnnotationWorkList work)
      Applies the specified annotations to all applicable serializer builders in this group.
      Parameters:
      work - The annotations to apply.
      Returns:
      This object.

    • marshallingContext

      public SerializerSet.Builder marshallingContext(MarshallingContext.Builder value)
      Associates an existing bean context builder with all serializer builders in this group.
      Parameters:
      value - The bean context builder to associate.
      Can be null (clears any previously-associated bean context builder).
      Returns:
      This object.

    • marshallingContext

      public final SerializerSet.Builder marshallingContext(Consumer<MarshallingContext.Builder> operation)
      Applies an operation to the bean context builder.
      Parameters:
      operation - The operation to apply.
      Returns:
      This object.

    • canApply

      public boolean canApply(AnnotationWorkList work)
      Returns true if at least one of the specified annotations can be applied to at least one serializer builder in this group.
      Parameters:
      work - The work to check.
      Returns:
      true if at least one of the specified annotations can be applied to at least one serializer builder in this group.

    • clear

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

    • copy

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

    • forEach

      public <T extends Serializer.Builder<?>> SerializerSet.Builder forEach(Class<T> type, Consumer<T> action)
      Performs an action on all serializer builders of the specified type in this group.
      Type Parameters:
      T - The serializer builder type.
      Parameters:
      type - The serializer builder type.
      action - The action to perform.
      Returns:
      This object.

    • forEach

      public SerializerSet.Builder forEach(Consumer<Serializer.Builder<?>> action)
      Performs an action on all serializer builders in this group.
      Parameters:
      action - The action to perform.
      Returns:
      This object.

    • forEachOSS

      public SerializerSet.Builder forEachOSS(Consumer<OutputStreamSerializer.Builder<?>> action)
      Performs an action on all output stream serializer builders in this group.
      Parameters:
      action - The action to perform.
      Returns:
      This object.

    • forEachWS

      public SerializerSet.Builder forEachWS(Consumer<WriterSerializer.Builder<?>> action)
      Performs an action on all writer serializer builders in this group.
      Parameters:
      action - The action to perform.
      Returns:
      This object.

    • impl

      public SerializerSet.Builder impl(Object value)
      Overrides the bean returned by the build() method with a pre-built instance.
      Parameters:
      value - The pre-built instance.
      Can be null (clears the override; build() constructs a new instance).
      Returns:
      This object.

    • inner

      public List<Object> inner()
      Returns direct access to the Serializer and Serializer.Builderobjects 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 Serializer and Serializer.Builderobjects.

      Returns:
      The inner list of entries in this builder.

    • set

      public SerializerSet.Builder set(Class<?>... values)
      Sets the specified serializers for this group.

      Existing values are overwritten.

      The SerializerSet.Inherit class can be used to insert existing entries in this group into the position specified.

      Example:

      SerializerSet.Builder builder = SerializerSet.create(); // Create an empty builder. builder.set(FooSerializer.class); // Now contains: [FooSerializer] builder.set(BarSerializer.class, BazSerializer.class); // Now contains: [BarParser,BazSerializer] builder.set(Inherit.class, QuxSerializer.class); // Now contains: [BarParser,BazSerializer,QuxSerializer]

      Parameters:
      values - The serializers to set in this group.
      Returns:
      This object.
      Throws:
      IllegalArgumentException - If one or more values do not extend from Serializer or named "Inherit".

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • build

      public SerializerSet build()
      Builds the serializer set.
      Returns:
      A new SerializerSet.