1 /*
   2  * Copyright (c) 1997, 2015, 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 com.sun.xml.internal.bind.v2.runtime.unmarshaller.XmlVisitor}
  37  * is parsing.
  38  *
  39  * @author Kohsuke Kawaguchi
  40  */
  41 public interface LocatorEx extends Locator {
  42     /**
  43      * Gets the current location in a {@link ValidationEventLocator} object.
  44      */
  45     ValidationEventLocator getLocation();
  46 
  47     /**
  48      * Immutable snapshot of a {@link LocatorEx}
  49      */
  50     public static final class Snapshot implements LocatorEx, ValidationEventLocator {
  51         private final int columnNumber,lineNumber,offset;
  52         private final String systemId,publicId;
  53         private final URL url;
  54         private final Object object;
  55         private final Node node;
  56 
  57         public Snapshot(LocatorEx loc) {
  58             columnNumber = loc.getColumnNumber();
  59             lineNumber = loc.getLineNumber();
  60             systemId = loc.getSystemId();
  61             publicId = loc.getPublicId();
  62 
  63             ValidationEventLocator vel = loc.getLocation();
  64             offset = vel.getOffset();
  65             url = vel.getURL();
  66             object = vel.getObject();
  67             node = vel.getNode();
  68         }
  69 
  70         public Object getObject() {
  71             return object;
  72         }
  73 
  74         public Node getNode() {
  75             return node;
  76         }
  77 
  78         public int getOffset() {
  79             return offset;
  80         }
  81 
  82         public URL getURL() {
  83             return url;
  84         }
  85 
  86         public int getColumnNumber() {
  87             return columnNumber;
  88         }
  89 
  90         public int getLineNumber() {
  91             return lineNumber;
  92         }
  93 
  94         public String getSystemId() {
  95             return systemId;
  96         }
  97 
  98         public String getPublicId() {
  99             return publicId;
 100         }
 101 
 102         public ValidationEventLocator getLocation() {
 103             return this;
 104         }
 105     }
 106 }