core/src/main/java/org/onap/aaf/cadi/wsse/XEvent.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aaf\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * * \r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * * \r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 package org.onap.aaf.cadi.wsse;\r
  24 \r
  25 import javax.xml.namespace.QName;\r
  26 import javax.xml.stream.events.XMLEvent;\r
  27 \r
  28 /**\r
  29  * XEvent\r
  30  * \r
  31  * This mechanism mimics a minimal portion of StAX "XMLEvent", enough to work with minimal XReader.\r
  32  * \r
  33  * We implement the same interface, as much as minimally necessary, as XMLEvent for these small usages so as to\r
  34  * be interchangeable in the future, if so desired\r
  35  * \r
  36  *\r
  37  */\r
  38 // @SuppressWarnings("restriction")\r
  39 public abstract class XEvent {\r
  40 \r
  41         public abstract int getEventType();\r
  42 \r
  43         public StartElement asStartElement() {\r
  44                 return (StartElement)this;\r
  45         }\r
  46 \r
  47         public Characters asCharacters() {\r
  48                 return (Characters)this;\r
  49         }\r
  50 \r
  51         public EndElement asEndElement() {\r
  52                 return (EndElement)this;\r
  53         }\r
  54 \r
  55     public static abstract class NamedXEvent extends XEvent {\r
  56         private QName qname;\r
  57 \r
  58         public NamedXEvent(QName qname) {\r
  59                 this.qname = qname;\r
  60         }\r
  61         \r
  62                 public QName getName() {\r
  63                 return qname;\r
  64         }\r
  65     }\r
  66         public static class StartElement extends NamedXEvent {\r
  67 \r
  68                 public StartElement(String ns, String tag) {\r
  69                         super(new QName(ns,tag));\r
  70                 }\r
  71 \r
  72                 @Override\r
  73                 public int getEventType() {\r
  74                         return XMLEvent.START_ELEMENT;\r
  75                 }\r
  76         }\r
  77 \r
  78         public static class EndElement extends NamedXEvent {\r
  79                 public EndElement(String ns, String tag) {\r
  80                         super(new QName(ns,tag));\r
  81                 }\r
  82                 \r
  83                 @Override\r
  84                 public int getEventType() {\r
  85                         return XMLEvent.END_ELEMENT;\r
  86                 }\r
  87         }\r
  88 \r
  89         public static class Characters extends XEvent {\r
  90                 private String data;\r
  91 \r
  92                 public Characters(String data) {\r
  93                         this.data = data;\r
  94                 }\r
  95                 @Override\r
  96                 public int getEventType() {\r
  97                         return XMLEvent.CHARACTERS;\r
  98                 }\r
  99 \r
 100                 public String getData() {\r
 101                         return data;\r
 102                 }\r
 103         }\r
 104         \r
 105         public static class StartDocument extends XEvent {\r
 106 \r
 107                 @Override\r
 108                 public int getEventType() {\r
 109                         return XMLEvent.START_DOCUMENT;\r
 110                 }\r
 111                 \r
 112         }\r
 113 \r
 114         public static class EndDocument extends XEvent {\r
 115 \r
 116                 @Override\r
 117                 public int getEventType() {\r
 118                         return XMLEvent.END_DOCUMENT;\r
 119                 }\r
 120                 \r
 121         }\r
 122         public static class Comment extends XEvent {\r
 123                 public final String value;\r
 124                 public Comment(String value) {\r
 125                         this.value = value;\r
 126                 }\r
 127 \r
 128                 @Override\r
 129                 public int getEventType() {\r
 130                         return XMLEvent.COMMENT;\r
 131                 }\r
 132         \r
 133         }\r
 134 \r
 135 }\r