com.sun.org.apache.xml.internal.utils: public class: SerializableLocatorImpl

com.sun.org.apache.xml.internal.utils
public class: SerializableLocatorImpl [javadoc | source]

java.lang.Object
   com.sun.org.apache.xml.internal.utils.SerializableLocatorImpl

All Implemented Interfaces:
Locator, Serializable

The standard SAX implementation of LocatorImpl is not serializable, limiting its utility as "a persistent snapshot of a locator". This is a quick hack to make it so. Note that it makes more sense in many cases to set up fields to hold this data rather than pointing at another object... but that decision should be made on architectural grounds rather than serializability.

It isn't clear whether subclassing LocatorImpl and adding serialization methods makes more sense than copying it and just adding Serializable to its interface. Since it's so simple, I've taken the latter approach for now.

Also see:

org.xml.sax.helpers.LocatorImpl

org.xml.sax.Locator Locator

since: XalanJ2 -

author: Joe - Kesselman

Field Summary
static final long	serialVersionUID

Constructor:

Constructor:
public SerializableLocatorImpl() { } Zero-argument constructor. SAX says "This will not normally be useful, since the main purpose of this class is to make a snapshot of an existing Locator." In fact, it _is_ sometimes useful when you want to construct a new Locator pointing to a specific location... which, after all, is why the setter methods are provided.
public SerializableLocatorImpl(Locator locator) { setPublicId(locator.getPublicId()); setSystemId(locator.getSystemId()); setLineNumber(locator.getLineNumber()); setColumnNumber(locator.getColumnNumber()); } Copy constructor. Create a persistent copy of the current state of a locator. When the original locator changes, this copy will still keep the original values (and it can be used outside the scope of DocumentHandler methods). Parameters: `locator` - The locator to copy.

 public SerializableLocatorImpl() {

}

Zero-argument constructor.

SAX says "This will not normally be useful, since the main purpose of this class is to make a snapshot of an existing Locator." In fact, it _is_ sometimes useful when you want to construct a new Locator pointing to a specific location... which, after all, is why the setter methods are provided.

 public SerializableLocatorImpl(Locator locator) {
        setPublicId(locator.getPublicId());
        setSystemId(locator.getSystemId());
        setLineNumber(locator.getLineNumber());
        setColumnNumber(locator.getColumnNumber());
}

Create a persistent copy of the current state of a locator. When the original locator changes, this copy will still keep the original values (and it can be used outside the scope of DocumentHandler methods).

Parameters:

locator - The locator to copy.

Method from com.sun.org.apache.xml.internal.utils.SerializableLocatorImpl Summary:
getColumnNumber, getLineNumber, getPublicId, getSystemId, setColumnNumber, setLineNumber, setPublicId, setSystemId

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.sun.org.apache.xml.internal.utils.SerializableLocatorImpl Detail:
public int getColumnNumber() { return columnNumber; } Return the saved column number (1-based).
public int getLineNumber() { return lineNumber; } Return the saved line number (1-based).
public String getPublicId() { return publicId; } Return the saved public identifier.
public String getSystemId() { return systemId; } Return the saved system identifier.
public void setColumnNumber(int columnNumber) { this.columnNumber = columnNumber; } Set the column number for this locator (1-based).
public void setLineNumber(int lineNumber) { this.lineNumber = lineNumber; } Set the line number for this locator (1-based).
public void setPublicId(String publicId) { this.publicId = publicId; } Set the public identifier for this locator.
public void setSystemId(String systemId) { this.systemId = systemId; } Set the system identifier for this locator.

Method from com.sun.org.apache.xml.internal.utils.SerializableLocatorImpl Detail:

 public int getColumnNumber() {
        return columnNumber;
}

Return the saved column number (1-based).

 public int getLineNumber() {
        return lineNumber;
}

Return the saved line number (1-based).

 public String getPublicId() {
        return publicId;
}

Return the saved public identifier.

 public String getSystemId() {
        return systemId;
}

Return the saved system identifier.

 public  void setColumnNumber(int columnNumber) {
        this.columnNumber = columnNumber;
}

Set the column number for this locator (1-based).

 public  void setLineNumber(int lineNumber) {
        this.lineNumber = lineNumber;
}

Set the line number for this locator (1-based).

 public  void setPublicId(String publicId) {
        this.publicId = publicId;
}

Set the public identifier for this locator.

 public  void setSystemId(String systemId) {
        this.systemId = systemId;
}

Set the system identifier for this locator.