ContextBuilder (Apache Juneau 8.1.2)

java.lang.Object
- org.apache.juneau.ContextBuilder

Direct Known Subclasses:

BeanContextBuilder, ConfigBuilder, ConfigStoreBuilder
```
public abstract class ContextBuilder
extends Object
```
Builder class for building instances of serializers and parsers.

Field Summary

Fields
Modifier and Type Field and Description

protected PropertyStoreBuilder psb
Contains all the modifiable settings for the implementation class.

Fields
Modifier and Type	Field and Description
`protected PropertyStoreBuilder`	`psb` Contains all the modifiable settings for the implementation class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ContextBuilder()` Constructor.
	`ContextBuilder(PropertyStore ps)` Constructor.
`protected`	`ContextBuilder(PropertyStoreBuilder psb)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ContextBuilder`	`add(Map<String,Object> properties)` Adds multiple configuration properties on this object.
`ContextBuilder`	`addTo(String name, Object value)` Adds a value to a SET or LIST property.
`ContextBuilder`	`addTo(String name, String key, Object value)` Adds or overwrites a value to a SET, LIST, or MAP property.
`ContextBuilder`	`apply(PropertyStore copyFrom)` Copies the settings from the specified property store into this builder.
`ContextBuilder`	`applyAnnotations(AnnotationList al, VarResolverSession r)` Applies a set of annotations to this property store.
`ContextBuilder`	`applyAnnotations(Class<?> fromClass)` Applies any of the various @XConfig annotations on the specified class to this context.
`ContextBuilder`	`applyAnnotations(Method fromMethod)` Applies any of the various @XConfig annotations on the specified method to this context.
`abstract Context`	`build()` Build the object.
`<T extends Context> T`	`build(Class<T> c)` Build a new instance of the specified object.
`PropertyStore`	`getPropertyStore()` Returns a read-only snapshot of the current property store on this builder.
`protected PropertyStoreBuilder`	`getPropertyStoreBuilder()` Returns access to the inner property store builder.
`<T> T`	`peek(Class<T> c, String key)` Peeks at a configuration property on this object.
`Object`	`peek(String key)` Peeks at a configuration property on this object.
`ContextBuilder`	`removeFrom(String name, Object value)` Removes a value from a SET, LIST, or MAP property.
`ContextBuilder`	`set(Map<String,Object> properties)` Sets multiple configuration properties on this object.
`ContextBuilder`	`set(String name, Object value)` Sets a configuration property on this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - psb
```
protected final PropertyStoreBuilder psb
```
    Contains all the modifiable settings for the implementation class.
- Constructor Detail
  - ContextBuilder
```
public ContextBuilder()
```
    Constructor. Default settings.
  - ContextBuilder
```
public ContextBuilder(PropertyStore ps)
```
    Constructor.
    
    Parameters:
    
    ps - The initial configuration settings for this builder.
  - ContextBuilder
```
protected ContextBuilder(PropertyStoreBuilder psb)
```
    Constructor.
    Used in cases where multiple context builder are sharing the same property store builder.
    (e.g. HtlmlDocBuilder)
    
    Parameters:
    
    psb - The property store builder to use.
- Method Detail
  - getPropertyStoreBuilder
```
protected PropertyStoreBuilder getPropertyStoreBuilder()
```
    Returns access to the inner property store builder.
    Used in conjunction with ContextBuilder(PropertyStoreBuilder) when builders share property store builders.
    
    Returns:
    
    The inner property store builder.
  - build
```
public abstract Context build()
```
    Build the object.
    
    Returns:
    
    The built object. Subsequent calls to this method will create new instances.
  - apply
```
public ContextBuilder apply(PropertyStore copyFrom)
```
    Copies the settings from the specified property store into this builder.
    
    Parameters:
    
    copyFrom - The factory whose settings are being copied.
    
    Returns:
    
    This object (for method chaining).
  - applyAnnotations
```
public ContextBuilder applyAnnotations(AnnotationList al,
                                       VarResolverSession r)
```
    Applies a set of annotations to this property store.
    
    Parameters:
    
    al - The list of all annotations annotated with PropertyStoreApply.
    
    r - The string resolver for resolving variables in annotation values.
    
    Returns:
    
    This object (for method chaining).
  - applyAnnotations
```
public ContextBuilder applyAnnotations(Class<?> fromClass)
```
    Applies any of the various @XConfig annotations on the specified class to this context.
    Applies any of the following annotations:
    Annotations 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.
    Parameters:
    
    fromClass - The class on which the annotations are defined.
    
    Returns:
    
    This object (for method chaining).
  - applyAnnotations
```
public ContextBuilder applyAnnotations(Method fromMethod)
```
    Applies any of the various @XConfig annotations on the specified method to this context.
    Applies any of the following annotations:
    Annotations are appended in the following orders:
    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.
    Parameters:
    
    fromMethod - The method on which the annotations are defined.
    
    Returns:
    
    This object (for method chaining).
  - build
```
public <T extends Context> T build(Class<T> c)
```
    Build a new instance of the specified object.
    
    Parameters:
    
    c - The subclass of Context to instantiate.
    
    Returns:
    
    A new object using the settings defined in this builder.
  - getPropertyStore
```
public PropertyStore getPropertyStore()
```
    Returns a read-only snapshot of the current property store on this builder.
    
    Returns:
    
    A property store object.
  - set
```
public ContextBuilder set(String name,
                          Object value)
```
    Sets a configuration property on this object.
    
    Parameters:
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - peek
```
public Object peek(String key)
```
    Peeks at a configuration property on this object.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    This object (for method chaining).
  - peek
```
public <T> T peek(Class<T> c,
                  String key)
```
    Peeks at a configuration property on this object.
    
    Type Parameters:
    
    T - The type to convert to.
    
    Parameters:
    
    c - The type to convert to.
    
    key - The property name.
    
    Returns:
    
    This object (for method chaining).
  - set
```
public ContextBuilder set(Map<String,Object> properties)
```
    Sets multiple configuration properties on this object.
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(java.util.Map)
  - add
```
public ContextBuilder add(Map<String,Object> properties)
```
    Adds multiple configuration properties on this object.
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.add(java.util.Map)
  - addTo
```
public ContextBuilder addTo(String name,
                            Object value)
```
    Adds a value to a SET or LIST property.
    
    Parameters:
    
    name - The property name.
    
    value - The new value to add to the SET property.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    ConfigException - If property is not a SET property.
  - addTo
```
public ContextBuilder addTo(String name,
                            String key,
                            Object value)
```
    Adds or overwrites a value to a SET, LIST, or MAP property.
    
    Parameters:
    
    name - The property name.
    
    key - The property value map key.
    
    value - The property value map value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    ConfigException - If property is not a MAP property.
  - removeFrom
```
public ContextBuilder removeFrom(String name,
                                 Object value)
```
    Removes a value from a SET, LIST, or MAP property.
    
    Parameters:
    
    name - The property name.
    
    value - The property value in the SET property.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    ConfigException - If property is not a SET property.

Class ContextBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

psb

Constructor Detail

ContextBuilder

ContextBuilder

ContextBuilder

Method Detail

getPropertyStoreBuilder

build

apply

applyAnnotations

applyAnnotations

applyAnnotations

build

getPropertyStore

set

peek

peek

set

add

addTo

addTo

removeFrom