X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=third-party%2Forg.openexi%2Fnagasena%2Fsrc%2Fmain%2Fresources%2Fdoc%2Forg%2Fopenexi%2Fproc%2Fio%2FScanner.html;fp=third-party%2Forg.openexi%2Fnagasena%2Fsrc%2Fmain%2Fresources%2Fdoc%2Forg%2Fopenexi%2Fproc%2Fio%2FScanner.html;h=82b51284e6b10d7ca29fdeb96ecd85bd32eb7a51;hp=0000000000000000000000000000000000000000;hb=1e81fa45ab0ced56eef0518c7e7f87857724985b;hpb=259b65622b8c29c49235c2210609b9f7a68826eb diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/Scanner.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/Scanner.html new file mode 100644 index 0000000000..82b51284e6 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/Scanner.html @@ -0,0 +1,354 @@ + + + + + + + +Scanner + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.io +
+Class Scanner

+
+java.lang.Object
+  extended by org.openexi.proc.grammars.Apparatus
+      extended by org.openexi.proc.io.Scanner
+
+
+
+
public abstract class Scanner
extends org.openexi.proc.grammars.Apparatus
+ + +

+The Scanner class provides methods for scanning events + in the body of an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.openexi.proc.grammars.Apparatus
CODEC_BASE64BINARY, CODEC_BOOLEAN, CODEC_DATE, CODEC_DATETIME, CODEC_DECIMAL, CODEC_DOUBLE, CODEC_ENUMERATION, CODEC_GDAY, CODEC_GMONTH, CODEC_GMONTHDAY, CODEC_GYEAR, CODEC_GYEARMONTH, CODEC_HEXBINARY, CODEC_INTEGER, CODEC_LEXICAL, CODEC_LIST, CODEC_STRING, CODEC_TIME, currentState, eventTypesWorkSpace, schema, stringTable
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcloseInputStream() + +
+          Close the input stream.
+ EXIOptionsgetHeaderOptions() + +
+          Returns the EXI Header options from the header of the + EXI stream, if present.
+abstract  EventDescriptionnextEvent() + +
+          Gets the next event from the EXI stream.
+abstract  voidsetBinaryChunkSize(int chunkSize) + +
+          Binary values are read in chunks of the specified size when the + use of binary data is enabled.
+ voidsetSchema(EXISchema schema, + QName[] dtrm, + int n_bindings) + +
+           
+  + + + + + + + +
Methods inherited from class org.openexi.proc.grammars.Apparatus
attribute, characters, endDocument, endElement, getAlignmentType, getNextEventCodes, getNextEventTypes, getPreserveLexicalValues, miscContent, nillify, reset, setPreserveLexicalValues, setStringTable, startDocument, startElement, startWildcardElement, undeclaredCharacters, wildcardAttribute, xsitp
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+setSchema

+
+public void setSchema(EXISchema schema,
+                      QName[] dtrm,
+                      int n_bindings)
+
+
+
Overrides:
setSchema in class org.openexi.proc.grammars.Apparatus
+
+
+
+
+
+
+ +

+nextEvent

+
+public abstract EventDescription nextEvent()
+                                    throws java.io.IOException
+
+
Gets the next event from the EXI stream. +

+

+ +
Returns:
EXIEvent +
Throws: +
java.io.IOException
+
+
+
+ +

+closeInputStream

+
+public void closeInputStream()
+                      throws java.io.IOException
+
+
Close the input stream. +

+

+ +
Throws: +
java.io.IOException
+
+
+
+ +

+getHeaderOptions

+
+public final EXIOptions getHeaderOptions()
+
+
Returns the EXI Header options from the header of the + EXI stream, if present. Otherwise, returns null. +

+

+ +
Returns:
EXIOptions or null if no header options are set.
+
+
+
+ +

+setBinaryChunkSize

+
+public abstract void setBinaryChunkSize(int chunkSize)
+
+
Binary values are read in chunks of the specified size when the + use of binary data is enabled. +

+

+
Parameters:
chunkSize -
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +