org.apache.velocity.tools.config
Class Configuration

java.lang.Object
  extended by org.apache.velocity.tools.config.Configuration
All Implemented Interfaces:
java.lang.Comparable<Configuration>
Direct Known Subclasses:
CompoundConfiguration, ToolConfiguration

public class Configuration
extends java.lang.Object
implements java.lang.Comparable<Configuration>

This base configuration class manages a set of Propertys for whatever thing the instance of this class represents. When combined with another Configuration instance via addConfiguration(org.apache.velocity.tools.config.Configuration), the Propertys of both instances are combined.

NOTE: Though this class appears Comparable, the compareTo(org.apache.velocity.tools.config.Configuration) method is unsupported. Proper comparison is left up to subclasses.

Version:
$Id: Configuration.java 511959 2007-02-26 19:24:39Z nbubna $
Author:
Nathan Bubna

Field Summary
private  java.util.SortedSet<Property> properties
           
 
Constructor Summary
Configuration()
           
 
Method Summary
 void addConfiguration(Configuration config)
           
 void addProperty(Property property)
           
protected  void appendProperties(java.lang.StringBuilder out)
           
 int compareTo(Configuration config)
           
 boolean equals(java.lang.Object obj)
           
 java.util.SortedSet<Property> getProperties()
           
 Property getProperty(java.lang.String name)
           
 java.util.Map<java.lang.String,java.lang.Object> getPropertyMap()
           
 int hashCode()
           
 boolean hasProperties()
           
 boolean removeProperty(Property property)
           
 boolean removeProperty(java.lang.String name)
           
 void setProperties(java.util.Collection<Property> props)
           
 void setProperty(java.lang.String name, java.lang.Object value)
           
 void setPropertyMap(java.util.Map<java.lang.String,java.lang.Object> props)
           
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

properties

private final java.util.SortedSet<Property> properties
Constructor Detail

Configuration

public Configuration()
Method Detail

addProperty

public void addProperty(Property property)

removeProperty

public boolean removeProperty(Property property)

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

removeProperty

public boolean removeProperty(java.lang.String name)

hasProperties

public boolean hasProperties()

getProperty

public Property getProperty(java.lang.String name)

getProperties

public java.util.SortedSet<Property> getProperties()

getPropertyMap

public java.util.Map<java.lang.String,java.lang.Object> getPropertyMap()

setPropertyMap

public void setPropertyMap(java.util.Map<java.lang.String,java.lang.Object> props)

setProperties

public void setProperties(java.util.Collection<Property> props)

addConfiguration

public void addConfiguration(Configuration config)

validate

public void validate()

compareTo

public int compareTo(Configuration config)
Specified by:
compareTo in interface java.lang.Comparable<Configuration>

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

appendProperties

protected void appendProperties(java.lang.StringBuilder out)


Copyright (c) 2003-2007 Apache Software Foundation