Top Description Fields Constructors Methods
net.sf.ehcache.config.generator.model

public Class SimpleNodeAttribute

extends Object
implements NodeAttribute
Class Inheritance
All Implemented Interfaces
net.sf.ehcache.config.generator.model.NodeAttribute
Implementation of the NodeAttribute interface
Author
Abhishek Sanoujam

Field Summary

Modifier and TypeField and Description
private String
defaultValue

private final String
name

private boolean
optional

private String
value

Constructor Summary

AccessConstructor and Description
public
SimpleNodeAttribute(String
the name of the attribute
name)

Constructor accepting the name of the attribute

public
SimpleNodeAttribute(String
the name of the attribute
name, Enum<E extends Enum<E>>
the Enum value of the attribute
value)

Constructor accepting name and Enum value of the attribute

public
SimpleNodeAttribute(String
the name of the attribute
name, int
the int value of the attribute
value)

Constructor accepting name and int value of the attribute

public
SimpleNodeAttribute(String
the name of the attribute
name, long
the long value of the attribute
value)

Constructor accepting name and long value of the attribute

public
SimpleNodeAttribute(String
the name of the attribute
name, boolean
the boolean value of the attribute
value)

Constructor accepting name and boolean value of the attribute

public
SimpleNodeAttribute(String
the name of the attribute
name, String
the String value of the attribute
value)

Constructor accepting name and String value of the attribute

Method Summary

Modifier and TypeMethod and Description
public SimpleNodeAttribute
defaultValue(String
the default value
defaultValue)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.defaultValue.

Builder convenience method for setting defaultValue
public SimpleNodeAttribute

Returns:

the same instance
defaultValue(boolean
the default value
defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

public SimpleNodeAttribute

Returns:

the same instance
defaultValue(int
the default value
defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

public SimpleNodeAttribute

Returns:

the same instance
defaultValue(Enum<E extends Enum<E>>
the default value
defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

public SimpleNodeAttribute

Returns:

the same instance
defaultValue(long
the default value
defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
getDefaultValue()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.getDefaultValue.

Returns the default value of the attribute
public String
getName()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.getName.

Name of the attribute
public String
getValue()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.getValue.

Value of the attribute
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isOptional()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.isOptional.

Returns true if the attribute is optional, otherwise false
public SimpleNodeAttribute
optional(boolean
true if optional
optional)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.optional.

Builder convenience method for setting optional
public void
setDefaultValue(String
the default value
defaultValue)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.setDefaultValue.

Default value setter
public void
setOptional(boolean
true if this attribute is optional
optional)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.setOptional.

Sets this attribute to optional or not
public void
setValue(String
the new value
value)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.setValue.

Setter for value
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

defaultValueback to summary
private String defaultValue
nameback to summary
private final String name
optionalback to summary
private boolean optional
valueback to summary
private String value

Constructor Detail

SimpleNodeAttributeback to summary
public SimpleNodeAttribute(String name)

Constructor accepting the name of the attribute

Parameters
name:String

the name of the attribute

SimpleNodeAttributeback to summary
public SimpleNodeAttribute(String name, Enum<E extends Enum<E>> value)

Constructor accepting name and Enum value of the attribute

Parameters
name:String

the name of the attribute

value:Enum<E extends Enum<E>>

the Enum value of the attribute

SimpleNodeAttributeback to summary
public SimpleNodeAttribute(String name, int value)

Constructor accepting name and int value of the attribute

Parameters
name:String

the name of the attribute

value:int

the int value of the attribute

SimpleNodeAttributeback to summary
public SimpleNodeAttribute(String name, long value)

Constructor accepting name and long value of the attribute

Parameters
name:String

the name of the attribute

value:long

the long value of the attribute

SimpleNodeAttributeback to summary
public SimpleNodeAttribute(String name, boolean value)

Constructor accepting name and boolean value of the attribute

Parameters
name:String

the name of the attribute

value:boolean

the boolean value of the attribute

SimpleNodeAttributeback to summary
public SimpleNodeAttribute(String name, String value)

Constructor accepting name and String value of the attribute

Parameters
name:String

the name of the attribute

value:String

the String value of the attribute

Method Detail

defaultValueback to summary
public SimpleNodeAttribute defaultValue(String defaultValue)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.defaultValue.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.defaultValue.

Builder convenience method for setting defaultValue

Parameters
defaultValue:String

the default value

Returns:SimpleNodeAttribute

the same attribute instance

defaultValueback to summary
public SimpleNodeAttribute defaultValue(boolean defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

Parameters
defaultValue:boolean

the default value

Returns:SimpleNodeAttribute

the same instance

defaultValueback to summary
public SimpleNodeAttribute defaultValue(int defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

Parameters
defaultValue:int

the default value

Returns:SimpleNodeAttribute

the same instance

defaultValueback to summary
public SimpleNodeAttribute defaultValue(Enum<E extends Enum<E>> defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

Parameters
defaultValue:Enum<E extends Enum<E>>

the default value

Returns:SimpleNodeAttribute

the same instance

defaultValueback to summary
public SimpleNodeAttribute defaultValue(long defaultValue)

Same as defaultValue(String) using String.valueOf(defaultValue)

Parameters
defaultValue:long

the default value

Returns:SimpleNodeAttribute

the same instance

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getDefaultValueback to summary
public String getDefaultValue()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.getDefaultValue.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.getDefaultValue.

Returns the default value of the attribute

Returns:String

default value of the attribute

getNameback to summary
public String getName()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.getName.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.getName.

Name of the attribute

Returns:String

Name of the attribute

getValueback to summary
public String getValue()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.getValue.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.getValue.

Value of the attribute

Returns:String

value of the attribute

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
isOptionalback to summary
public boolean isOptional()

Implements net.sf.ehcache.config.generator.model.NodeAttribute.isOptional.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.isOptional.

Returns true if the attribute is optional, otherwise false

Returns:boolean

Returns true if the attribute is optional, otherwise false

optionalback to summary
public SimpleNodeAttribute optional(boolean optional)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.optional.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.optional.

Builder convenience method for setting optional

Parameters
optional:boolean

true if optional

Returns:SimpleNodeAttribute

the same attribute instance

setDefaultValueback to summary
public void setDefaultValue(String defaultValue)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.setDefaultValue.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.setDefaultValue.

Default value setter

Parameters
defaultValue:String

the default value

setOptionalback to summary
public void setOptional(boolean optional)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.setOptional.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.setOptional.

Sets this attribute to optional or not

Parameters
optional:boolean

true if this attribute is optional

setValueback to summary
public void setValue(String value)

Implements net.sf.ehcache.config.generator.model.NodeAttribute.setValue.

Doc from net.sf.ehcache.config.generator.model.NodeAttribute.setValue.

Setter for value

Parameters
value:String

the new value

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override