org.geotools
Interface Builder<T>

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

public interface Builder<T>

Builder interface used to impose consistency on Builder implementations.


Method Summary
 T build()
          Created object, may be null if unset()
 Builder<T> reset()
          Configure the Builder to produce a default result.
 Builder<T> reset(T original)
          Configure the Builder to produce a copy of the provided original.
 Builder<T> unset()
          Configure the Builder to produce null.
 

Method Detail

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:
origional - 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()


Copyright © 1996-2010 Geotools. All Rights Reserved.