1 /*
   2  * Copyright (c) 2009, 2020, 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 javax.xml.stream.events;
  27 /**
  28  * An interface for handling Notation Declarations
  29  *
  30  * Receive notification of a notation declaration event.
  31  * It is up to the application to record the notation for later reference,
  32  * At least one of publicId and systemId must be non-null.
  33  * There is no guarantee that the notation declaration
  34  * will be reported before any unparsed entities that use it.
  35  *
  36  * @version 1.0
  37  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
  38  * @since 1.6
  39  */
  40 public interface NotationDeclaration extends XMLEvent {
  41   /**
  42    * The notation name.
  43    * @return the name
  44    */
  45   String getName();
  46 
  47   /**
  48    * The notation's public identifier, or null if none was given.
  49    * @return the public identifier
  50    */
  51   String getPublicId();
  52 
  53   /**
  54    * The notation's system identifier, or null if none was given.
  55    * @return the system identifier
  56    */
  57   String getSystemId();
  58 }