/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.xerces.stax;
import javax.xml.stream.Location;
Location which always returns -1
and null
from its methods.
@xerces.internal Version: $Id: EmptyLocation.java 730444 2008-12-31 19:11:29Z mrglavas $
/**
* <p>Location which always returns <code>-1</code>
* and <code>null</code> from its methods.</p>
*
* @xerces.internal
*
* @version $Id: EmptyLocation.java 730444 2008-12-31 19:11:29Z mrglavas $
*/
public final class EmptyLocation implements Location {
Singleton instance.
/**
* Singleton instance.
*/
private static final EmptyLocation EMPTY_LOCATION_INSTANCE
= new EmptyLocation();
private EmptyLocation() {}
Returns the one and only instance of this class. /** Returns the one and only instance of this class. */
public static EmptyLocation getInstance() {
return EMPTY_LOCATION_INSTANCE;
}
Return the line number where the current event ends,
returns -1 if none is available.
Returns: the current line number
/**
* Return the line number where the current event ends,
* returns -1 if none is available.
* @return the current line number
*/
public int getLineNumber() {
return -1;
}
Return the column number where the current event ends,
returns -1 if none is available.
Returns: the current column number
/**
* Return the column number where the current event ends,
* returns -1 if none is available.
* @return the current column number
*/
public int getColumnNumber() {
return -1;
}
Return the byte or character offset into the input source this location
is pointing to. If the input source is a file or a byte stream then
this is the byte offset into that stream, but if the input source is
a character media then the offset is the character offset.
Returns -1 if there is no offset available.
Returns: the current offset
/**
* Return the byte or character offset into the input source this location
* is pointing to. If the input source is a file or a byte stream then
* this is the byte offset into that stream, but if the input source is
* a character media then the offset is the character offset.
* Returns -1 if there is no offset available.
* @return the current offset
*/
public int getCharacterOffset() {
return -1;
}
Returns the public ID of the XML
Returns: the public ID, or null if not available
/**
* Returns the public ID of the XML
* @return the public ID, or null if not available
*/
public String getPublicId() {
return null;
}
Returns the system ID of the XML
Returns: the system ID, or null if not available
/**
* Returns the system ID of the XML
* @return the system ID, or null if not available
*/
public String getSystemId() {
return null;
}
}