Package org.apache.juneau.config

Class Config.Builder

java.lang.Object
org.apache.juneau.Context.Builder
org.apache.juneau.config.Config.Builder
Enclosing class:
Config
public static class Config.Builder extends Context.Builder
Builder class.

  • Constructor Details

    • Builder

      protected Builder()
      Constructor, default settings.

    • Builder

      protected Builder(Config.Builder copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The builder to copy from.

    • Builder

      protected Builder(Config copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The bean to copy from.

  • Method Details

    • annotations

      public Config.Builder annotations(Annotation... values)
      Description copied from class: Context.Builder
      Defines annotations to apply to specific classes and methods.

      Allows you to dynamically apply Juneau annotations typically applied directly to classes and methods. Useful in cases where you want to use the functionality of the annotation on beans and bean properties but do not have access to the code to do so.

      As a rule, any Juneau annotation with an on() method can be used with this setting.

      The following example shows the equivalent methods for applying the @Bean annotation:

      // Class with explicit annotation. @Bean(properties="street,city,state") public class A {...} // Class with annotation applied via @BeanConfig public class B {...} // Java REST method with @BeanConfig annotation. @RestGet(...) @Bean(on="B", properties="street,city,state") public void doFoo() {...}

      In general, the underlying framework uses this method when it finds dynamically applied annotations on config annotations. However, concrete implementations of annotations are also provided that can be passed directly into builder classes like so:

      // Create a concrete @Bean annotation. Bean annotation = BeanAnnotation.create(B.class).properties("street,city,state").build(); // Apply it to a serializer. WriterSerializer serializer = JsonSerializer.create().annotations(annotation).build(); // Serialize a bean with the dynamically applied annotation. String json = serializer.serialize(new B());

      The following is the list of annotations builders provided that can be constructed and passed into the builder class:

      The syntax for the on() pattern match parameter depends on whether it applies to a class, method, field, or constructor. The valid pattern matches are:

      • Classes:
        • Fully qualified:
          • "com.foo.MyClass"
        • Fully qualified inner class:
          • "com.foo.MyClass$Inner1$Inner2"
        • Simple:
          • "MyClass"
        • Simple inner:
          • "MyClass$Inner1$Inner2"
          • "Inner1$Inner2"
          • "Inner2"
      • Methods:
        • Fully qualified with args:
          • "com.foo.MyClass.myMethod(String,int)"
          • "com.foo.MyClass.myMethod(java.lang.String,int)"
          • "com.foo.MyClass.myMethod()"
        • Fully qualified:
          • "com.foo.MyClass.myMethod"
        • Simple with args:
          • "MyClass.myMethod(String,int)"
          • "MyClass.myMethod(java.lang.String,int)"
          • "MyClass.myMethod()"
        • Simple:
          • "MyClass.myMethod"
        • Simple inner class:
          • "MyClass$Inner1$Inner2.myMethod"
          • "Inner1$Inner2.myMethod"
          • "Inner2.myMethod"
      • Fields:
        • Fully qualified:
          • "com.foo.MyClass.myField"
        • Simple:
          • "MyClass.myField"
        • Simple inner class:
          • "MyClass$Inner1$Inner2.myField"
          • "Inner1$Inner2.myField"
          • "Inner2.myField"
      • Constructors:
        • Fully qualified with args:
          • "com.foo.MyClass(String,int)"
          • "com.foo.MyClass(java.lang.String,int)"
          • "com.foo.MyClass()"
        • Simple with args:
          • "MyClass(String,int)"
          • "MyClass(java.lang.String,int)"
          • "MyClass()"
        • Simple inner class:
          • "MyClass$Inner1$Inner2()"
          • "Inner1$Inner2()"
          • "Inner2()"
      • A comma-delimited list of anything on this list.
      See Also:
      Overrides:
      annotations in class Context.Builder
      Parameters:
      values - The annotations to register with the context.
      Cannot contain null values.
      Returns:
      This object.

    • annotations

      public Config.Builder annotations(List<Annotation> values)
      Description copied from class: Context.Builder
      Same as Context.Builder.annotations(Annotation...) but uses a list as input.
      Overrides:
      annotations in class Context.Builder
      Parameters:
      values - The annotations to register with the context.
      Cannot be null or contain null values.
      Returns:
      This object.

    • apply

      public Config.Builder apply(AnnotationWorkList work)
      Description copied from class: Context.Builder
      Applies a set of applied to this builder.

      An AnnotationWork consists of a single pair of AnnotationInfo that represents an annotation instance, and AnnotationApplier which represents the code used to apply the values in that annotation to a specific builder.

      Example:

      // A class annotated with a config annotation. @BeanConfig(sortProperties="$S{sortProperties,false}") public class MyClass {...} // Find all annotations that themselves are annotated with @ContextPropertiesApply. Stream<AnnotationInfo<?>> annotations = ClassInfo.of(MyClass.class).getAnnotations().stream().filter(CONTEXT_APPLY_FILTER); VarResolverSession vrs = VarResolver.DEFAULT.createSession(); AnnotationWorkList work = AnnotationWorkList.of(vrs, annotations); // Apply any settings found on the annotations. WriterSerializer serializer = JsonSerializer .create() .apply(work) .build();

      Overrides:
      apply in class Context.Builder
      Parameters:
      work - The list of annotations and appliers to apply to this builder.
      Cannot be null.
      Returns:
      This object.

    • applyAnnotations

      public Config.Builder applyAnnotations(Class<?>... from)
      Description copied from class: Context.Builder
      Same as Context.Builder.applyAnnotations(Object...) but explicitly specifies a class varargs to avoid compilation warnings.
      Overrides:
      applyAnnotations in class Context.Builder
      Parameters:
      from - The classes or methods on which the annotations are defined.
      Cannot contain null values.
      Returns:
      This object.

    • applyAnnotations

      public Config.Builder applyAnnotations(Object... from)
      Description copied from class: Context.Builder
      Applies any of the various @XConfig annotations on the specified classes or methods to this context.

      Any annotations found that themselves are annotated with ContextApply will be resolved and applied as properties to this builder. These annotations include:

      Annotations on classes are appended in the following order:

      1. On the package of this class.
      2. On interfaces ordered parent-to-child.
      3. On parent classes ordered parent-to-child.
      4. On this class.

      Annotations on methods are appended in the following order:

      1. On the package of the method class.
      2. On interfaces ordered parent-to-child.
      3. On parent classes ordered parent-to-child.
      4. On the method class.
      5. On this method and matching methods ordered parent-to-child.

      The default var resolver VarResolver.DEFAULT is used to resolve any variables in annotation field values.

      Example:

      // A class annotated with a config annotation. @BeanConfig(sortProperties="$S{sortProperties,false}") public class MyClass {...} // Apply any settings found on the annotations. WriterSerializer serializer = JsonSerializer .create() .applyAnnotations(MyClass.class) .build(); // A method annotated with a config annotation. public class MyClass { @BeanConfig(sortProperties="$S{sortProperties,false}") public void myMethod() {...} } // Apply any settings found on the annotations. WriterSerializer serializer = JsonSerializer .create() .applyAnnotations(MyClass.class.getMethod("myMethod")) .build();

      Overrides:
      applyAnnotations in class Context.Builder
      Parameters:
      from - The classes or methods on which the annotations are defined. Can be any of the following types:
      Returns:
      This object.

    • binaryFormat

      public Config.Builder binaryFormat(BinaryFormat value)
      Binary value format.

      The format to use when persisting byte arrays.

      Parameters:
      value - The new value for this property.
      The default is the first value found:
      • System property "Config.binaryFormat"
      • Environment variable "CONFIG_BINARYFORMAT"
      • BinaryFormat.BASE64

      Cannot be null.
      Returns:
      This object.

    • binaryLineLength

      public Config.Builder binaryLineLength(int value)
      Binary value line length.

      When serializing binary values, lines will be split after this many characters.
      Use -1 to represent no line splitting.

      Parameters:
      value - The new value for this property.
      The default is the first value found:
      • System property "Config.binaryLineLength"
      • Environment variable "CONFIG_BINARYLINELENGTH"
      • -1
      Returns:
      This object.

    • build

      public Config build()
      Description copied from class: Context.Builder
      Build the object.
      Overrides:
      build in class Context.Builder
      Returns:
      The built object.

    • cache

      public Config.Builder cache(Cache<HashKey,? extends Context> value)
      Description copied from class: Context.Builder
      Specifies a cache to use for hashkey-based caching.

      When a cache is specified, contexts with the same hash key will be reused from the cache instead of creating new instances. This improves performance when building multiple contexts with identical configurations.

      If null is specified, caching is disabled and each call to Context.Builder.build() will create a new context instance.

      Overrides:
      cache in class Context.Builder
      Parameters:
      value - The cache.
      Can be null (disables caching, each build creates a new instance).
      Returns:
      This object.

    • copy

      public Config.Builder copy()
      Description copied from class: Context.Builder
      Copy creator.
      Specified by:
      copy in class Context.Builder
      Returns:
      A new mutable copy of this builder.

    • debug

      public Config.Builder debug()
      Description copied from class: Context.Builder
      Context configuration property:  Debug mode.

      Enables the following additional information during serialization:

      Enables the following additional information during parsing:

      • When bean setters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.
      Example:

      // Create a serializer with debug enabled. WriterSerializer serializer = JsonSerializer .create() .debug() .build(); // Create a POJO model with a recursive loop. public class MyBean { public Object f; } MyBean bean = new MyBean(); bean.f = bean; // Throws a SerializeException and not a StackOverflowError String json = serializer.serialize(bean);

      See Also:
      Overrides:
      debug in class Context.Builder
      Returns:
      This object.

    • debug

      public Config.Builder debug(boolean value)
      Description copied from class: Context.Builder
      Same as Context.Builder.debug() but allows you to explicitly specify the value.
      Overrides:
      debug in class Context.Builder
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • impl

      public Config.Builder impl(Context value)
      Description copied from class: Context.Builder
      Specifies a pre-instantiated bean for the Context.Builder.build() method to return.

      If a non-null value is provided and it's an instance of the context type, Context.Builder.build() will return that instance instead of creating a new one. If null, the normal build process continues.

      Overrides:
      impl in class Context.Builder
      Parameters:
      value - The value for this setting.
      Can be null (normal build process will continue).
      Returns:
      This object.

    • memStore

      public Config.Builder memStore()
      Configuration store.

      Convenience method for calling store(ConfigMemoryStore.DEFAULT).

      Returns:
      This object.

    • mods

      public Config.Builder mods(Mod... values)
      Adds a value modifier.

      Modifiers are used to modify entry value before being persisted.

      Parameters:
      values - The mods to apply to this config.
      Cannot contain null values.
      Returns:
      This object.

    • multiLineValuesOnSeparateLines

      public Config.Builder multiLineValuesOnSeparateLines()
      Multi-line values on separate lines.

      When enabled, multi-line values will always be placed on a separate line from the key.

      The default is the first value found:

      • System property "Config.multiLineValuesOnSeparateLine"
      • Environment variable "CONFIG_MULTILINEVALUESONSEPARATELINE"
      • false
      Returns:
      This object.

    • name

      public Config.Builder name(String value)
      Configuration name.

      Specifies the configuration name.
      This is typically the configuration file name, although the name can be anything identifiable by the ConfigStore used for retrieving and storing the configuration.

      Parameters:
      value - The new value for this property.
      The default is the first value found:
      • System property "Config.name"
      • Environment variable "CONFIG_NAME"
      • "Configuration.cfg"

      Cannot be null.
      Returns:
      This object.

    • parser

      public Config.Builder parser(ReaderParser value)
      POJO parser.

      The parser to use for parsing values to POJOs.

      Parameters:
      value - The new value for this property.
      The default is JsonParser.DEFAULT.
      Cannot be null.
      Returns:
      This object.

    • readOnly

      public Config.Builder readOnly()
      Read-only mode.

      When enabled, attempts to call any setters on this object will throw an UnsupportedOperationException.

      The default is the first value found:

      • System property "Config.readOnly"
      • Environment variable "CONFIG_READONLY"
      • false
      Returns:
      This object.

    • serializer

      public Config.Builder serializer(WriterSerializer value)
      POJO serializer.

      The serializer to use for serializing POJO values.

      Parameters:
      value - The new value for this property.
      The default is Json5Serializer.DEFAULT
      Cannot be null.
      Returns:
      This object.

    • store

      public Config.Builder store(ConfigStore value)
      Configuration store.

      The configuration store used for retrieving and storing configurations.

      Parameters:
      value - The new value for this property.
      The default is FileStore.DEFAULT.
      Cannot be null.
      Returns:
      This object.

    • type

      public Config.Builder type(Class<? extends Context> value)
      Description copied from class: Context.Builder
      Associates a context class with this builder.

      This is the type of object that this builder creates when the Context.Builder.build() method is called.

      By default, it's the outer class of where the builder class is defined.

      If null is set, Context.Builder.build() will throw an exception. The default constructor automatically sets this to the outer class, so null should only be set explicitly if you want to override the default.

      Overrides:
      type in class Context.Builder
      Parameters:
      value - The context class that this builder should create.
      Can be null (will cause Context.Builder.build() to throw an exception).
      Returns:
      This object.

    • varResolver

      public Config.Builder varResolver(VarResolver value)
      SVL variable resolver.

      The resolver to use for resolving SVL variables.

      Parameters:
      value - The new value for this property.
      The default is VarResolver.DEFAULT.
      Cannot be null.
      Returns:
      This object.