Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.opensymphony.xwork2.util.location
Class LocatableProperties

    java.lang.Object
      java.util.Dictionary<K,V>
          java.util.Hashtable<Object,Object>
              java.util.Properties
                  com.opensymphony.xwork2.util.location.LocatableProperties

All Implemented Interfaces:
  Locatable, Serializable, Cloneable, Map<Object,Object>

Direct Known Subclasses:
  DefaultConfiguration.ContainerProperties

    public class LocatableProperties

extends Properties
implements Locatable

Properties implementation that remembers the location of each property. When loaded, a custom properties file parser is used to remember both the line number and preceeding comments for each property entry.

See Also:
  Serialized Form

Field Summary
`(package private) Location` | `location`
`(package private) Map<String,Location>` | `propLocations`

Fields inherited from class java.util.Properties
`defaults`

Constructor Summary
`LocatableProperties()`
`LocatableProperties(Location loc)`

Method Summary
`(package private) String` | `convertCommentsToString(List<String> lines)`
`Location` | `getLocation()` Get the location of this object
`Location` | `getPropertyLocation(String key)`
`void` | `load(InputStream in)`
`Object` | `setProperty(String key, String value, Object locationObj)`

Methods inherited from class java.util.Properties
`getProperty, getProperty, list, list, loadFromXML, propertyNames, save, setProperty, store, storeToXML, storeToXML`

Methods inherited from class java.util.Hashtable
`clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

### location

    Location location

### propLocations

    Map<String,Location> propLocations

Constructor Detail

### LocatableProperties

    public LocatableProperties()

### LocatableProperties

    public LocatableProperties(Location loc)

Method Detail

### load

    public void load(InputStream in)
              throws IOException

  Overrides:
    `load` in class `Properties`
  Throws:
    `IOException`

### convertCommentsToString

    String convertCommentsToString(List<String> lines)

### setProperty

    public Object setProperty(String key,
                              String value,
                              Object locationObj)

### getPropertyLocation

    public Location getPropertyLocation(String key)

### getLocation

    public Location getLocation()

  Description copied from interface: `Locatable`
  Get the location of this object

  Specified by:
    `getLocation` in interface `Locatable`
  Returns:
    the location

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2007 OpenSymphony. All Rights Reserved.