org.apache.commons.digester3.binder
Class SetPropertyBuilder

java.lang.Object
  extended by org.apache.commons.digester3.binder.SetPropertyBuilder
All Implemented Interfaces:
RuleProvider<SetPropertyRule>

public final class SetPropertyBuilder
extends Object

Builder chained when invoking LinkedRuleBuilder.setProperty(String).

Since:
3.0

Method Summary
protected  SetPropertyRule createRule()
          Provides an instance of Rule.
 SetPropertyBuilder extractingValueFromAttribute(String valueAttributeName)
          Set the name of the attribute that will contain the value to which the property should be set.
 R get()
          Provides an instance of Rule.
 String getNamespaceURI()
          Returns the namespace URI for which this Rule is relevant, if any.
 String getPattern()
          Returns the rule pattern associated to this builder.
protected  void reportError(String methodChain, String message)
           
 LinkedRuleBuilder then()
          Come back to the main LinkedRuleBuilder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

extractingValueFromAttribute

public SetPropertyBuilder extractingValueFromAttribute(String valueAttributeName)
Set the name of the attribute that will contain the value to which the property should be set.

Parameters:
valueAttributeName - Name of the attribute that will contain the value to which the property should be set.
Returns:
this builder instance

createRule

protected SetPropertyRule createRule()
Provides an instance of Rule. Must never return null.

Returns:
an instance of Rule.
See Also:
get()

then

public final LinkedRuleBuilder then()
Come back to the main LinkedRuleBuilder.

Returns:
the main LinkedRuleBuilder

getNamespaceURI

public final String getNamespaceURI()
Returns the namespace URI for which this Rule is relevant, if any.

Returns:
The namespace URI for which this Rule is relevant, if any

get

public final R get()
Provides an instance of Rule. Must never return null.

Specified by:
get in interface RuleProvider<R extends Rule>
Returns:
an instance of Rule.

reportError

protected final void reportError(String methodChain,
                                 String message)

getPattern

public final String getPattern()
Returns the rule pattern associated to this builder.

Returns:
The rule pattern associated to this builder


Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.