1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.bind.v2.runtime.unmarshaller;
  27 
  28 import java.net.URL;
  29 
  30 import javax.xml.bind.ValidationEventLocator;
  31 
  32 import org.xml.sax.Locator;
  33 import org.w3c.dom.Node;
  34 
  35 /**
  36  * Object that returns the current location that the {@link XmlVisitor} is parsing.
  37  *
  38  * @author Kohsuke Kawaguchi
  39  */
  40 public interface LocatorEx extends Locator {
  41     /**
  42      * Gets the current location in a {@link ValidationEventLocator} object.
  43      */
  44     ValidationEventLocator getLocation();
  45 
  46     /**
  47      * Immutable snapshot of a {@link LocatorEx}
  48      */
  49     public static final class Snapshot implements LocatorEx, ValidationEventLocator {
  50         private final int columnNumber,lineNumber,offset;
  51         private final String systemId,publicId;
  52         private final URL url;
  53         private final Object object;
  54         private final Node node;
  55 
  56         public Snapshot(LocatorEx loc) {
  57             columnNumber = loc.getColumnNumber();
  58             lineNumber = loc.getLineNumber();
  59             systemId = loc.getSystemId();
  60             publicId = loc.getPublicId();
  61 
  62             ValidationEventLocator vel = loc.getLocation();
  63             offset = vel.getOffset();
  64             url = vel.getURL();
  65             object = vel.getObject();
  66             node = vel.getNode();
  67         }
  68 
  69         public Object getObject() {
  70             return object;
  71         }
  72 
  73         public Node getNode() {
  74             return node;
  75         }
  76 
  77         public int getOffset() {
  78             return offset;
  79         }
  80 
  81         public URL getURL() {
  82             return url;
  83         }
  84 
  85         public int getColumnNumber() {
  86             return columnNumber;
  87         }
  88 
  89         public int getLineNumber() {
  90             return lineNumber;
  91         }
  92 
  93         public String getSystemId() {
  94             return systemId;
  95         }
  96 
  97         public String getPublicId() {
  98             return publicId;
  99         }
 100 
 101         public ValidationEventLocator getLocation() {
 102             return this;
 103         }
 104     }
 105 }