Interface Builder<T>

Type Parameters:
T - class of object under construction
All Known Implementing Classes:
AddBuilder, AnchorPointBuilder, AndBuilder, ChannelSelectionBuilder, ChildExpressionBuilder, ColorMapBuilder, ColorMapEntryBuilder, ColorReplacementBuilder, ContrastEnhancementBuilder, DescriptionBuilder, DisplacementBuilder, DivideBuilder, ExpressionBuilder, ExtensionSymbolizerBuilder, ExtentBuilder, ExternalGraphicBuilder, ExternalMarkBuilder, FeatureTypeConstraintBuilder, FeatureTypeStyleBuilder, FillBuilder, FilterBuilder, FontBuilder, FunctionBuilder, FunctionBuilder.ParamBuilder, GraphicBuilder, GraphicLegendBuilder, HaloBuilder, IdBuilder, LayerFeatureConstraintsBuilder, LinePlacementBuilder, LineSymbolizerBuilder, LiteralBuilder, MarkBuilder, MultiplyBuilder, NamedLayerBuilder, NilBuilder, PointPlacementBuilder, PointSymbolizerBuilder, PolygonSymbolizerBuilder, PropertyNameBuilder, RasterSymbolizerBuilder, RemoteOWSBuilder, RuleBuilder, SelectedChannelTypeBuilder, ShadedReliefBuilder, StrokeBuilder, StyleBuilder, StyledLayerDescriptorBuilder, SubFilterBuilder, SubtractBuilder, SymbolizerBuilder, TextSymbolizerBuilder, UserLayerBuilder

public interface Builder<T>
Builder interface used to impose consistency on Builder implementations.
  • Method Summary

    Modifier and Type
    Method
    Description
    Created object, may be null if unset()
    Configure the Builder to produce a default result.
    reset(T original)
    Configure the Builder to produce a copy of the provided original.
    Configure the Builder to produce null.
  • Method Details

    • unset

      Builder<T> unset()
      Configure the Builder to produce null.

      This method allows a Builder to be used as a placeholder; in its unset state the build() method will produce null. If any of the builder methods are used the builder will produce a result.

      Returns:
      Builder configured to build null
    • reset

      Builder<T> reset()
      Configure the Builder to produce a default result.
      Returns:
      Builder configured to produce a default result.
    • reset

      Builder<T> reset(T original)
      Configure the Builder to produce a copy of the provided original.
      Parameters:
      original - Original, if null this will behave the same as unset()
      Returns:
      Builder configured to produce the provided original
    • build

      T build()
      Created object, may be null if unset()
      Returns:
      Created object may be null if unset()