diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
deleted file mode 100644
index dde02181..00000000
--- a/docs/DeveloperGuide.md
+++ /dev/null
@@ -1,359 +0,0 @@
-# DSLink Java Developer Guide
-
-[Home](https://github.com/iot-dsa-v2/sdk-dslink-java-v2) • [Javadoc](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/)
-
-## Warning
-
-Only use org.iot.dsa APIs, do not use or depend on anything in the com.* packages.
-
-Please utilize the
-[Javadoc](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/)
-for the core sdk. It's not perfect, but the more it is referenced, the better it will get.
-
-## Overview
-
-The purpose of this document is to guide the reader through the development of Java DSA links using
-this SDK. Developers will build links using the org.iot.dsa.* packages found in
-dslink-core sub-project.
-
-Key objectives of this SDK:
-
- - Pluggable architecture:
- - Protocol independence. Primarily to support DSA V1 and V2.
- - Transport independence. Websockets, plain sockets, http, and whatever else comes along.
- - Support multiple Java links in the same process.
- - Support JDK 1.6 for Distech Controls.
- - High performance for activities such as video streaming.
- - Support very large configuration databases (100K+ points).
- - Support poll on demand whenever possible.
- - 3rd party library independence. Some environments such as Niagara provide transport libraries
- while others do not. SLF4J and Netty were explicitly bound to the original SDK but can not be
- used in Niagara because of it's very strict Security Manager.
-
-## Creating a Link
-
-These are the major steps you'll take when creating a link:
-
-1. Copy example link.
-2. Create application nodes.
-
-## Copy Example Link
-
-Copy the
-[dslink-java-v2-example](https://github.com/iot-dsa-v2/dslink-java-v2-example)
-project to create a new repository. It's README provides
-detailed instructions for customization.
-
-The example link is a very simple but fully functioning link with a single root node. It is
-recommended you get that running within a broker before continuing with this documentation.
-
-## Create Application Nodes
-
-Nodes are where application specific logic is bound to the link architecture. Node developers
-will use various lifecycle callbacks to trigger their logic.
-
-<<<<<<< HEAD
-First you must create a root node. It is the hook for the rest of your functionality. The
-convention is to name it MainNode, but make sure it is in a unique package so that multiple links
-=======
-First you must create a root application node. It is the hook for the rest of your functionality.
-The convention is to name it MainNode, but make sure it is in a unique package so that multiple links
->>>>>>> 22064982f1faddb35f2da7c8a183dbbc8602cbe9
-can be run in the same process.
-
-Then you will probably create additional nodes that will be descendants in the tree rooted by your
-main node.
-
-### Main Node
-
-<<<<<<< HEAD
-All links require a single root node and it must subclass
-[org.iot.dsa.dslink.DSMainNode](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/dslink/DSMainNode.html).
-The convention is to name the class MainNode but the package must be unique from any other
-MainNodes so that multiple links can be run in the same process.
-
-When a link launches the first time, the type of the root node is looked up **dslink.json**.
-The config _mainType_ must store the fully qualified class name of the root node. After the first
-launch, the configuration database is serialized and the _mainType_ config will longer have an
-=======
-All links require a single root data node and it must subclass
-[org.iot.dsa.dslink.DSMainNode](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/dslink/DSMainNode.html).
-The convention is to name the class MainNode but the package must be unique from any other
-MainNodes (other links) so that multiple links can be run in the same process.
-
-When a link launches the first time, the type of the main node is looked up **dslink.json**.
-The config _handler_class_ must store the fully qualified class name of the root node. After the first
-launch, the configuration database is serialized and the _handler_class_ config will longer have an
->>>>>>> 22064982f1faddb35f2da7c8a183dbbc8602cbe9
-impact.
-
-### Additional Nodes
-
-[org.iot.dsa.node.DSNode](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/node/DSNode.html)
-is the organizational unit of a link. It can contain values, actions and other nodes. Most if not
-all of a link's custom functionality will be implemented as DSNode subclasses.
-
-Subclassing DSNode requires to key steps:
-
-1. Configure the default children (nodes, values and actions).
-2. Use various lifecycle callbacks to trigger custom functionality.
-
-### Constructors
-
-DSNode sub-classes must support the public no-arg constructor. This is how they will be
-instantiated when deserializing the configuration database.
-
-### Defaults
-
-Every subclass of DSNode has a private default instance, all other instances are copies of the
-default instance. It is an instanced based inheritance scheme that will allow subtypes to remove or
-reorder 'fields' declared in super classes.
-
-Since there is a default instance in memory, You should never perform application logic unless
-triggered by a callback and your node is running (started or stable).
-
-If a DSNode subtype needs to have specific child nodes or values (most will), it should override
-the declareDefaults method. The method should:
-
-1. Call super.declareDefaults(). It's not always necessary but it's safest to do so.
-2. Call DSNode.declareDefault(String name, DSIObject child) for each non-removable child. Do not
-add dynamic children in declareDefaults, because if they are removed, they will be re-added the
-next time the link is restarted.
-
-```java
- @Override
- protected void declareDefaults() {
- super.declareDefaults();
- declareDefault("Do Something", DSAction.DEFAULT);
- declareDefault("An Integer Value", DSInt.valueOf(0));
- declareDefault("Child Node", new DSNode());
- }
-```
-
-During node serialization (configuration database, not DSA interop), child values that match their
-declared default are omitted. This has two benefits:
-
-1. A smaller node database means faster serialization / deserialization.
-2. Default values can be modified in code and all existing databases with values at the default
-will be automatically upgraded the next time the updated class is loaded.
-
-### Node Lifecycle
-
-It is important to know the application lifecycle. Use lifecycle callbacks to trigger custom link
-functionality.
-
-_Nodes should not execute any application logic unless they are running (started or stable)._
-
-**Stopped**
-
-A node is instantiated in the stopped state. If a node tree has been persisted, it will be be fully
-restored in the stopped state. DSNode.onStopped will not be called, it is only called when nodes
-transition from running to stopped.
-
-When nodes are removed from a running parent node, they will be stopped. DSNode.onStopped will be
-called after all child nodes have been stopped.
-
-When a link is stopped, an attempt to stop the tree will be made, but it cannot be guaranteed.
-
-**Started**
-
-After the node tree is fully deserialized it will be started. A node's onStart method will be
-called after all of its child nodes have been started. The only guarantee is that all child
-nodes have been started.
-
-Nodes will also started when they are added to an already running parent node.
-
-**Stable**
-
-Stable is called after the entire tree has been started. The first time the node tree is loaded,
-there is a stable delay of 5 seconds.
-
-Nodes added to an already stable parent will have onStart and onStable called immediately.
-
-When in doubt of whether to use onStarted or onStable, use onStable.
-
-**Callbacks**
-
-When a node is stable, there are several callbacks for various state changes. All callbacks
-begin with **on** such as _onChildAdded()_. See the
-[DSNode Javadoc](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/node/DSNode.html)
-for a complete list.
-
-### Subscriptions
-
-Nodes should suspend, or minimize activity when nothing is interested in them. For example, if
-nothing is interested in a point, it is best to not poll the point on the foreign system.
-
-To do this you use the following APIs:
-
-* DSNode.onSubscribed - Called when the node transitions from unsubscribed to subscribed. This is
-not called for subsequent subscribers once in the subscribed state.
-* DSNode.onUnsubscribed - Called when the node transitions from subscribed to unsubscribed. If
-there are multiple subscribers, this is only called when the last one unsubscribes.
-* DSNode.isSubscribed - Tells the caller whether or not the node is subscribed.
-
-### Values
-
-Values mostly represent leaf members of the node tree. There are two types of values:
-
-1. [org.io.dsa.node.DSElement](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/node/DSElement.html) -
-These are the primitives that mostly map to the JSON type system and will be leaf members of the tree.
-2. [org.io.dsa.node.DSIValue](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/node/DSIValue.html) -
-These have to be able to convert to DSElements, but they carry additional meaning such as timestamp.
-Nodes can implement this to have both a value and children. DSValueNode is a convenience abstract
-class for this purpose.
-
-The node model encourages values to be immutable and singletons. This is for efficiency, the same
-value instance (e.g. DSBoolean.TRUE) can be stored in many nodes.
-
-Whenever possible, values should also have NULL instance. Rather than storing a generic null,
-this helps the system decode the proper type such as when a requester is attempting to set
-a value.
-
-### Actions
-
-Actions allow allow responders to expose functionality in DSA that can't be modeled as values.
-
-Add actions to your node using
-[org.iot.dsa.node.action.DSAction](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/node/action/DSAction.html).
-
-Override DSNode.onInvoke to handle invocations.
-
-```java
- private DSInfo doSomething = getInfo("Do Something");
-
- @Override
- protected void declareDefaults() {
- DSAction action = new DSAction();
- action.addParameter("Arg", DSString.valueOf("arg"), "A description");
- declareDefault("Do Something", action);
- }
-
- private void doSomething(String arg) {}
-
- @Override
- public ActionResult onInvoke(DSInfo actionInfo, ActionInvocation invocation) {
- if (actionInfo == doSomething) {
- DSElement arg = invocation.getParameters().get("Arg");
- doSomething(arg.toString());
- return null;
- }
- return super.onInvoke(actionInfo, invocation);
- }
-```
-
-DSAction can be subclassed. Actions should also be singleton instances for efficiency. For
-parameter-less actions that have no return value, use the DSAction.DEFAULT instance.
-
-### DSInfo
-
-All node children have corresponding DSInfo instances. This type serves serves two purposes:
-
-1. It carries some meta-data about the relationship between the parent node and the child.
-2. It tracks whether or not the child matches a declared default.
-
-Important things for developers to know about DSInfo are:
-
-* You can configure state such as transient, readonly and hidden.
-* You can declare fields in the your Java class for info instances to avoid looking up the child
-every time it is needed. This is can be used to create fast getters and setters.
-
-Without declaring fields (lookups required):
-
-```java
- public void declareDefaults() {
- super.declareDefaults();
- declareDefault("The Int", DSInt.valueOf(0));
- }
- public int getTheInt() {
- DSInt theInt = (DSInt) get("The Int"); //map lookup
- return theInt.toInt();
- }
- public void setTheInt(int value) {
- put("The Int", DSInt.valueOf(value)); //map lookup
- }
-```
-
-
-With declared fields:
-
-```java
- private DSInfo theInt = getInfo("The Int"); //will be null in the default instance
- public void declareDefaults() {
- super.declareDefaults();
- declareDefault("The Int", DSInt.valueOf(0));
- }
- public int getTheInt() {
- return theInt.toInt(); //no lookup
- }
- public void setTheInt(int value) {
- put(theInt, DSInt.valueOf(value)); //no lookup
- }
-```
-
-### Metadata
-
-Metadata can be information such as units for number types and ranges for enums.
-
-When the system collects metadata about an object, it uses these steps:
-
-1. If the target value or node implements
-[org.iot.dsa.node.DSIMetadata](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/node/DSIMetadata.html).
-it will be given the opportunity to provide metadata first.
-2. Then getMetadata on the parent node will be called with the DSInfo representing the child.
-This will be useful when nodes want to store user editable metadata.
-
-To simplify configuring metadata, use the utility class
-[org.iot.dsa.node.DSMetadata](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/node/DSMetadata.html).
-
-## Timers and Threads
-
-Use [org.iot.dsa.DSRuntime](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/DSRuntime.html).
-
-Please avoid using Java executors if possible. In the future we will probably monitor DSRuntime
-to help determine when a system is becoming overloaded.
-
-Creating your own threads for long lived activities is perfectly acceptable but not necessary.
-
-## Logging
-
-Use Java Util Logging (JUL). A high performance async logger is automatically installed as the
-root logger.
-
-Most types subclass
-[org.iot.dsa.logging.DSLogger](https://iot-dsa-v2.github.io/sdk-dslink-java-v2/javadoc/index.html?org/iot/dsa/logging/DSLogger.html)
-as a convenience.
-
-The most efficient logging will not submit a log message if the level isn't enabled. This is
-how it is normally achieved with JUL:
-
-```java
- if (myLogger.isLoggable(Level.FINE)) {
- myLogger.fine(someMessage());
- }
-```
-
-
-DSLogger enables the same but with more concise syntax:
-
-```java
- fine(fine() ? someMessage() : null);
-```
-
-
-DSA has it's own log levels (there can be links in many different languages). All standard
-Java log level are mapped into it, but try to use the DSA levels:
-
-Level Guidelines
-
-DSA Level = Java Level
-
-- trace = Level.FINEST;
-- debug = Level.FINER;
-- fine = Level.FINE;
-- warn = custom
-- info = Level.INFO;
-- error = Level.WARNING;
-- admin = custom
-- fatal = Level.SEVERE;
-
diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html
deleted file mode 100644
index f311ea10..00000000
--- a/docs/javadoc/allclasses-frame.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-All Classes (dslink-core 0.19.0 API)
-All Classes (dslink-core 0.20.0 API)
-All Classes
-
-
-
diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html
deleted file mode 100644
index c83d281e..00000000
--- a/docs/javadoc/allclasses-noframe.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-All Classes (dslink-core 0.19.0 API)
-All Classes (dslink-core 0.20.0 API)
-All Classes
-
-
-
diff --git a/docs/javadoc/constant-values.html b/docs/javadoc/constant-values.html
deleted file mode 100644
index 63876533..00000000
--- a/docs/javadoc/constant-values.html
+++ /dev/null
@@ -1,849 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-Constant Field Values (dslink-core 0.19.0 API)
-Constant Field Values (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
org.iot.*
-
-
-
-
-org.iot.dsa.io.json.JsonConstants
-Modifier and Type
-Constant Field
-Value
-
-
-
-
-
- public static final java.lang.StringDBL_NAN "\u001bNaN"
-
-
-
- public static final java.lang.StringDBL_NEG_INF "\u001b-Infinity"
-
-
-
- public static final java.lang.StringDBL_POS_INF "\u001bInfinity"
-
-
-
-
-
-
-
-org.iot.dsa.logging.DSILevels
-Modifier and Type
-Constant Field
-Value
-
-
-
-
-
- public static final intADMIN 950
-
-
-
- public static final intCONFIG 700
-
-
-
- public static final intDEBUG 400
-
-
-
- public static final intERROR 900
-
-
-
- public static final intFATAL 1000
-
-
-
- public static final intFINE 500
-
-
-
- public static final intINFO 800
-
-
-
- public static final intTRACE 300
-
-
-
- public static final intWARN 750
-
-
-
-
-
-
-
-org.iot.dsa.node.DSMetadata
-Modifier and Type
-Constant Field
-Value
-
-
-
-
-
- public static final java.lang.StringBOOLEAN_RANGE "$booleanRange"
-
-
-
- public static final java.lang.StringDECIMAL_PLACES "$decimalPlaces"
-
-
-
- public static final java.lang.StringDEFAULT "$default"
-
-
-
- public static final java.lang.StringDESCRIPTION "$description"
-
-
-
- public static final java.lang.StringDISPLAY_NAME "displayName""$displayName"
-
-
-
- public static final java.lang.StringEDITOR "$editor"
-
-
-
- public static final java.lang.StringENUM_RANGE "$enumRange"
-
-
-
- public static final java.lang.StringMAX_VALUE "$maxValue"
-
-
-
- public static final java.lang.StringMIN_VALUE "$minValue"
-
-
-
- public static final java.lang.StringNAME "$name"
-
-
-
- public static final java.lang.StringPLACEHOLDER "$placeholder"
-
-
-
- public static final java.lang.StringTYPE "$type"
-
-
-
- public static final java.lang.StringUNIT "$unit"
-
-
-
-
-
-
-
-
-
Deprecated List (dslink-core 0.19.0 API)
-Deprecated List (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/javadoc/help-doc.html b/docs/javadoc/help-doc.html
deleted file mode 100644
index 9b70f116..00000000
--- a/docs/javadoc/help-doc.html
+++ /dev/null
@@ -1,233 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-API Help (dslink-core 0.19.0 API)
-API Help (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-Overview
-The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
-
-
-Package
-Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
-
-Interfaces (italic)
-Classes
-Enums
-Exceptions
-Errors
-Annotation Types
-
-
-
-Class/Interface
-Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
-
-Class inheritance diagram
-Direct Subclasses
-All Known Subinterfaces
-All Known Implementing Classes
-Class/interface declaration
-Class/interface description
-
-
-Nested Class Summary
-Field Summary
-Constructor Summary
-Method Summary
-
-
-Field Detail
-Constructor Detail
-Method Detail
-
-Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
-
-
-Annotation Type
-Each annotation type has its own separate page with the following sections:
-
-Annotation Type declaration
-Annotation Type description
-Required Element Summary
-Optional Element Summary
-Element Detail
-
-
-
-Enum
-Each enum has its own separate page with the following sections:
-
-Enum declaration
-Enum description
-Enum Constant Summary
-Enum Constant Detail
-
-
-
-Tree (Class Hierarchy)
-There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
-
-When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
-When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
-
-
-
-Deprecated API
-The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
-
-
-Index
-The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
-
-
-Prev/Next
-These links take you to the next or previous class, interface, package, or related page.
-
-
-Frames/No Frames
-These links show and hide the HTML frames. All pages are available with or without frames.
-
-
-All Classes
-The All Classes link shows all classes and interfaces except non-static nested types.
-
-
-Serialized Form
-Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
-
-
-Constant Field Values
-The Constant Field Values page lists the static final fields and their values.
-
-
-
This help file applies to API documentation generated using the standard doclet. Index (dslink-core 0.19.0 API)
-Index (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-A B C D E F G H I J K L M N O P R S T U V W
-
-
-
A
-
-AbstractInvokeHandler org.iot.dsa.dslink.requester
-Convenience implementation of the callback passed to the invoke method in the requester.
-
-AbstractInvokeHandler() AbstractInvokeHandler
-AbstractJsonWriter org.iot.dsa.io.json
-AbstractJsonWriter() AbstractJsonWriter
-AbstractListHandler org.iot.dsa.dslink.requester
-Convenience implementation of the handler passed to the invoke method in the requester.
-
-AbstractListHandler() AbstractListHandler
-AbstractReader org.iot.dsa.io
-Basic implementation of DSReader.
-
-AbstractReader() AbstractReader
-AbstractSubscribeHandler org.iot.dsa.dslink.requester
-Convenience implementation of the handler passed to the subscribe method in the requester.
-
-AbstractSubscribeHandler() AbstractSubscribeHandler
-AbstractWriter org.iot.dsa.io
-Basic implementation of DSWriter.
-
-AbstractWriter() AbstractWriter
-ActionInvocation org.iot.dsa.node.action
-Encapsulates the details of an action invocation and provides the mechanism for updating and open
- stream.
-
-ActionResult org.iot.dsa.node.action
-Super interface for possible results of an action.
-
-ActionSpec org.iot.dsa.node.action
-Defines an invokable node in the DSA model.
-
-ActionSpec.ResultType org.iot.dsa.node.action
-Defines what the action returns.
-
-ActionTable org.iot.dsa.node.action
-Provides access to the columns and rows of a table.
-
-ActionValues org.iot.dsa.node.action
-Simple set of return values from an action.
-
-add(DSElement) DSList
-Adds the value and returns this.
-
-add(boolean) DSList
-Appends the primitive and returns this.
-
-add(double) DSList
-Appends the primitive and returns this.
-
-add(long) DSList
-Appends the primitive and returns this.
-
-add(String) DSList
-Appends the primitive and returns this.
-
-add(int) DSList
-Appends the primitive and returns this.
-
-add(String, DSIObject) DSNode
-Adds the named child only if the name is not already in use.
-
-addAll(DSList) DSList
-Add all elements of the argument to this list and returns this.
-
-addDays(int, Calendar) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addDays(int, long) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addDefaultParameter(String, DSIValue, String) DSAction
-A convenience which calls addParameter with the same arguments, and also sets the metadata
- for the default value.
-
-addHours(int, Calendar) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addHours(int, long) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addList() DSList
-Appends a new list and returns it.
-
-addListener(DSLinkConnection.Listener) DSLinkConnection
-Adds a listener for connection events.
-
-addMap() DSList
-Appends a new map and returns it.
-
-addMinutes(int, Calendar) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addMinutes(int, long) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addMonths(int, Calendar) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addMonths(int, long) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addNull() DSList
-Appends null and returns this.
-
-addParameter(DSMap) DSAction
-Fully describes a parameter for method invocation.
-
-addParameter(String, DSIValue, String) DSAction
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the parameter
- list and returns the metadata instance for further configuration.
-
-addParameter(String, DSValueType, String) DSAction
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the parameter
- list and returns the metadata instance for further configuration.
-
-addResult(DSIValue) DSActionValues
-Values must be added in the same order they were defined in the action.
-
-addSeconds(int, Calendar) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addSeconds(int, long) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addValueResult(DSMap) DSAction
-Fully describes a return value when the result type is VALUES.
-
-addValueResult(String, DSIValue) DSAction
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the results
- list and returns the metadata instance for further configuration.
-
-addValueResult(String, DSValueType) DSAction
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the results
- list and returns the metadata instance for further configuration.
-
-addWeeks(int, Calendar) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addWeeks(int, long) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addYears(int, Calendar) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-addYears(int, long) DSTime
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-ADMIN DSILevels
-admin DSILevels
-admin() DSLogger
-True if the level is loggable.
-
-admin(Object) DSLogger
-admin(Object, Throwable) DSLogger
-alignDay(Calendar) DSTime
-Aligns the time fields to the start of the day.
-
-alignDays(int, Calendar) DSTime
-Aligns the time fields to the start of given interval.
-
-alignHour(Calendar) DSTime
-Aligns the time fields to the start of the hour.
-
-alignHours(int, Calendar) DSTime
-Aligns the time fields to the start of given interval.
-
-alignMinute(Calendar) DSTime
-Aligns the time fields to the start of the minute.
-
-alignMinutes(int, Calendar) DSTime
-Aligns the time fields to the start of given interval.
-
-alignMonth(Calendar) DSTime
-Aligns the time fields to the start of the month.
-
-alignSecond(Calendar) DSTime
-Aligns the time fields to the start of the second.
-
-alignSeconds(int, Calendar) DSTime
-Aligns the time fields to the start of given interval.
-
-alignWeek(Calendar) DSTime
-Aligns the time fields to the start of the week.
-
-alignYear(Calendar) DSTime
-Aligns the time fields to the start of the year.
-
-all DSILevels
-ApiObject org.iot.dsa.dslink.responder
-Can be a node, value or an action.
-
-append(char[], int, int) AbstractJsonWriter
-Append the characters and return this.
-
-append(char) JsonAppender
-Append the char and return this.
-
-append(char[], int, int) JsonAppender
-Append the chars and return this.
-
-append(CharSequence) JsonAppender
-Append the chars and return this.
-
-append(CharSequence, int, int) JsonAppender
-Append the chars and return this.
-
-append(CharSequence) JsonWriter
-append(char) JsonWriter
-append(CharSequence, int, int) JsonWriter
-Append the chars and return this.
-
-append(char[], int, int) JsonWriter
-Append the chars and return this.
-
-AsyncLogHandler org.iot.dsa.logging
-Enqueues logging records which are then processed by separate thread.
-
-AsyncLogHandler() AsyncLogHandler
-
-
-
-
-
B
-
-beginList() AbstractWriter
-beginList(int) AbstractWriter
-beginList() DSIWriter
-Start a new list and return this.
-
-beginList(int) DSIWriter
-Start a new list of the given size and return this.
-
-beginMap() AbstractWriter
-beginMap(int) AbstractWriter
-beginMap() DSIWriter
-Start a new map and return this.
-
-beginMap(int) DSIWriter
-Start a new map of the given size and return this.
-
-BOOLEAN_RANGE DSMetadata
-
-
-
-
-
C
-
-cancel() DSRuntime.Timer
-Cancel execution, will not impact current running tasks and will have no effect if
- already cancelled.
-
-CFG_AUTH_TOKEN DSLinkConfig
-CFG_BROKER_URL DSLinkConfig
-CFG_CONNECTION_TYPE DSLinkConfig
-CFG_KEY_FILE DSLinkConfig
-CFG_LOG_LEVEL DSLinkConfig
-CFG_NODE_FILE DSLinkConfig
-CFG_READ_TIMEOUT DSLinkConfig
-CFG_SAVE_INTERVAL DSLinkConfig
-CFG_STABLE_DELAY DSLinkConfig
-CFG_WS_TRANSPORT_FACTORY DSLinkConfig
-childAdded(ApiObject) InboundListRequest
-The responder should call this whenever a child is added.
-
-childCount() DSNode
-The number of children.
-
-childRemoved(ApiObject) InboundListRequest
-The responder should call this whenever a child is removed.
-
-clear() DSGroup
-Removes all items.
-
-clear() DSList
-clear() DSMap
-clear() DSMetadata
-clear(String) DSMetadata
-clear() DSNode
-Removes non-permanent children.
-
-clearAllRows() ActionInvocation
-Only use with stream and open tables, instructs the requester to clear all existing rows.
-
-close() InboundListRequest
-Allows the responder to forcefully close the list stream.
-
-close(Exception) InboundListRequest
-Allows the responder to forcefully close the list stream.
-
-close() InboundSubscribeRequest
-Allows the responder to forcefully terminate the subscription.
-
-close() DSIReader
-Close the input.
-
-close() DSIWriter
-Close the stream.
-
-close() JsonAppender
-close() JsonReader
-close() JsonWriter
-close() AsyncLogHandler
-Closes the PrintStream, terminates the write thread and performs houseKeeping.
-
-close() DSLogging
-Closes all async log handlers.
-
-close() ActionInvocation
-For use with streams and open tables, will have no effect if the stream is already closed.
-
-close(Exception) ActionInvocation
-Close and send and error.
-
-closeStream() OutboundStream
-Allows the requester to close the stream.
-
-concat(String, String, StringBuilder) DSPath
-Concatenates the two paths into the given bucket.
-
-CONFIG DSILevels
-CONFIG_FAULT DSStatus
-Bad, a configuration error has been indentified within DSA.
-
-CONFIG_FAULT_STR DSStatus
-configFault DSStatus
-contains(DSElement) DSList
-contains(String) DSMap
-contains(String) DSNode
-Whether or not this node has a child with the given name.
-
-copy() DSAction
-copy() DSElement
-If an object is mutable (list or map) then this should clone it, immutable objects can simply
- return themselves.
-
-copy() DSFlexEnum
-copy() DSInfo
-copy() DSIObject
-Return a copy if it makes sense, but return this otherwise.
-
-copy() DSList
-copy() DSMap
-copy() DSNode
-Returns a clone of this node and its subtree.
-
-copy() DSNull
-Returns this.
-
-copy() DSValue
-Returns this.
-
-copy() DSTopic
-Returns this.
-
-count(long, long) DSInterval
-Returns the number of intervals for the given time range, or -1 if indeterminate.
-
-currentTime() DSDateTime
-The current time.
-
-
-
-
-
-
D
-
-DBL_NAN JsonConstants
-How Double.NaN is encoded: "\\u001BNaN"
-
-DBL_NEG_INF JsonConstants
-How Double.NEGATIVE_INFINITY is encoded: "\\u001B-Infinity"
-
-DBL_POS_INF JsonConstants
-How Double.POSITIVE_INFINITY is encoded: "\\u001BInfinity"
-
-DEBUG DSILevels
-debug DSILevels
-debug() DSLogger
-True if the level is loggable.
-
-debug(Object) DSLogger
-Log a debug event.
-
-debug(Object, Throwable) DSLogger
-Log a debug event.
-
-DECIMAL_PLACES DSMetadata
-declareDefault(String, DSIObject) DSNode
-Use this in the declareDefaults method to create a non-removable child.
-
-declareDefaults() DSLink
-Adds the save action, overrides should call super if they want this action.
-
-declareDefaults() DSSysNode
-declareDefaults() DSNode
-The is only called once for each class.
-
-decode(String) DSBase64
-Decodes a base 64 encoded string.
-
-decode(DSIReader) NodeDecoder
-Reads a node tree from the given input.
-
-decode(String) DSBytes
-decode() DSPasswordAes
-Returns the decrypted password.
-
-decode(String) DSTime
-This is a convenience that uses reuses and recycles a calendar instance to get the time in
- millis.
-
-decode(String, Calendar) DSTime
-Converts a DSA encoded timestamp into a Java Calendar.
-
-decodeKeys(String) DSKeys
-Decodes an instance that was encoded with encodeKeys().
-
-decodeName(String) DSPath
-Un-escapes a name.
-
-decodePath(String) DSPath
-Splits the path and decodes each individual name.
-
-decodePrivate(byte[]) DSKeys
-Decodes the X9.63 encoding of a public key.
-
-decodePublic(byte[]) DSKeys
-Decodes the X9.63 encoding of a public key.
-
-decodeState(DSElement) DSInfo
-DEFAULT SimpleRequestHandler
-An instance that can be used for those requests where the callbacks don't really matter.
-
-DEFAULT DSAction
-Use this when you have no-arg, no-return actions.
-
-DEFAULT DSMetadata
-DEFAULT_BACKUP_THRESHOLD DSLogging
-This is the threshold, not a hard limit: 10 megs by default.
-
-DEFAULT_MAX_BACKUPS DSLogging
-The default number of backups to retain: 10 by default.
-
-DEFAULT_MAX_QUEUE DSLogging
-Max async queue size: 2500 by default.
-
-DESCRIPTION DSMetadata
-DISABLED DSStatus
-Bad, the object has been disabled within DSA.
-
-disabled DSStatus
-DISABLED_STR DSStatus
-disconnect() DSLinkConnection
-Forcefully closes an open connection.
-
-DISPLAY_NAME DSMetadata
-DOWN DSStatus
-Bad, communications are down within DSA.
-
-down DSStatus
-DOWN_STR DSStatus
-DSAction org.iot.dsa.node.action
-Fully describes an action and routes invocations to DSNode.onInvoke.
-
-DSAction() DSAction
-DSActionValues org.iot.dsa.node.action
-This is a convenience implementation of ActionValues.
-
-DSActionValues(DSAction) DSActionValues
-DSBase64 org.iot.dsa.io
-Thread-safe Base64 encoder and decoder.
-
-DSBase64() DSBase64
-DSBool org.iot.dsa.node
-Represents a boolean value.
-
-DSBytes org.iot.dsa.node
-Byte array that gets encoded as a base64 string.
-
-DSDateTime org.iot.dsa.time
-Wrapper for Java time.
-
-DSDouble org.iot.dsa.node
-A 64 bit floating point (Java double).
-
-DSElement org.iot.dsa.node
-The primitives of the node model.
-
-DSElement() DSElement
-DSElementType org.iot.dsa.node
-The core set of elements that translate directly to a JSON type.
-
-DSException org.iot.dsa.util
-An runtime exception that forwards most calls to the inner exception.
-
-DSException(Throwable) DSException
-DSFlexEnum org.iot.dsa.node
-An enum where the value and range can be created at runtime, primarily intended for defining
- action parameters.
-
-DSFloat org.iot.dsa.node
-A Java float.
-
-DSGroup org.iot.dsa.node
-An index accessible collection of primitives.
-
-DSGroup() DSGroup
-DSIBoolean org.iot.dsa.node
-Indicates something that is/has a boolean value.
-
-DSIEnum org.iot.dsa.node
-DSA Enum mapping.
-
-DSIEvent org.iot.dsa.node.event
-This is an empty interface, DSTopics are allowed to define events however they wish.
-
-DSILevels org.iot.dsa.logging
-DSIMetadata org.iot.dsa.node
-Nodes and values can implement this to provide meta-data about themselves.
-
-DSInfo org.iot.dsa.node
-All node children have corresponding DSInfo instances.
-
-DSInfoTopic org.iot.dsa.node.event
-This topic is for info related events on DSNodes.
-
-DSInfoTopic.Event org.iot.dsa.node.event
-The possible events for this topic.
-
-DSInt org.iot.dsa.node
-A Java int.
-
-DSInternalErrorException org.iot.dsa.dslink
-Indicates an unsupported method.
-
-DSInternalErrorException() DSInternalErrorException
-DSInternalErrorException(String) DSInternalErrorException
-DSInterval org.iot.dsa.time
-Enum representing periods of time.
-
-DSINumber org.iot.dsa.node
-Indicates something that is/has a numeric value.
-
-DSInvalidPathException org.iot.dsa.dslink
-Indicates a request path was invalid.
-
-DSInvalidPathException(String) DSInvalidPathException
-DSIObject org.iot.dsa.node
-Super class of anything found in the node tree.
-
-DSIPassword org.iot.dsa.security
-Defines the api for verifying passwords.
-
-DSIReader org.iot.dsa.io
-A decoder that can be used to get an entire graph in pieces, or one large group, or somewhere in
- between.
-
-DSIReader.Token org.iot.dsa.io
-Represents the state of the reader, and determines which getter should be called next.
-
-DSIRequester org.iot.dsa.dslink
-Interface for submitting outbound requests.
-
-DSIResponder org.iot.dsa.dslink
-Interface for nodes in the node tree to manually handle requests.
-
-DSIStatus org.iot.dsa.node
-Indicates something that is/has a quality.
-
-DSIStorable org.iot.dsa.node
-Enables custom serialization for non-node values in the configuration database.
-
-DSISubscriber org.iot.dsa.node.event
-=======
-
-Enables custom serialization for non-node values in the configuration database.
-
- DSISubscriber org.iot.dsa.node.event
->>>>>>> 22064982f1faddb35f2da7c8a183dbbc8602cbe9
-DSISubscribers subscribe to DSTopics on DSNodes.
-
-DSIValue org.iot.dsa.node
-How data values are represented in the node tree.
-
-DSIWriter org.iot.dsa.io
-An encoder that can be used to encode large graphs with or without object instances.
-
-DSJavaEnum org.iot.dsa.node
-Wrapper for Java enums.
-
-DSKeys org.iot.dsa.security
-DSA public private key pair.
-
-DSKeys(File) DSKeys
-Creates a DSKeys object by decoding existing keys from the given file.
-
-DSKeys(KeyPair) DSKeys
-Creates a DSKeys object for an existing key pair.
-
-DSKeys.Signer org.iot.dsa.security
-Signs bytes.
-
-DSKeys.Verifier org.iot.dsa.security
-Verifies signatures.
-
-DSLink org.iot.dsa.dslink
-Represents an upstream connection, a node tree, and manages the lifecycle of both.
-
-DSLink() DSLink
-Use the load method to create links.
-
-DSLinkConfig org.iot.dsa.dslink
-Configuration options for starting a link.
-
-DSLinkConfig() DSLinkConfig
-This will create an empty unvalidated getConfig.
-
-DSLinkConfig(File) DSLinkConfig
-Can be use to change the working dir from the default process working dir.
-
-DSLinkConfig(String) DSLinkConfig
-Constructor for simulating a command line invocation, the argument will be split on the space
- character.
-
-DSLinkConfig(String[]) DSLinkConfig
-Constructor for the arguments pass to a main method.
-
-DSLinkConnection org.iot.dsa.dslink
-Represents an upstream connection with a broker.
-
-DSLinkConnection() DSLinkConnection
-DSLinkConnection.Listener org.iot.dsa.dslink
-Intended for requester functionality so that requesters can know when to
- start and stop making requests.
-
-DSList org.iot.dsa.node
-Indexed collection of elements.
-
-DSList() DSList
-DSLogger org.iot.dsa.logging
-Adds an abstraction layer on Java Util Logging for two purposes:
-
-
-
- To use the DSA levels.
-
-DSLogger() DSLogger
-DSLogging org.iot.dsa.logging
-Static utilities for configuring the logging subsystem.
-
-DSLong org.iot.dsa.node
-A 64 bit integer (a Java long).
-
-DSMainNode org.iot.dsa.dslink
-The root DSNode that triggers a link's custom functionality .
-
-DSMainNode() DSMainNode
-DSMap org.iot.dsa.node
-String keyed collection of elements that preserves the order of addition.
-
-DSMap() DSMap
-DSMap.Entry org.iot.dsa.node
-Allows values to be accessed quickly by index in the list, rather than having to do a key
- lookup in the map.
-
-DSMetadata org.iot.dsa.node
-Utility fon constructing metadata maps.
-
-DSMetadata() DSMetadata
-DSMetadata(DSMap) DSMetadata
-DSNode org.iot.dsa.node
-The organizational unit of the node tree.
-
-DSNode() DSNode
-DSNull org.iot.dsa.node
-Try not to use, it is for decoding raw json.
-
-DSPasswordAes org.iot.dsa.security
-Stores an encrypted password which can be decrypted.
-
-DSPasswordSha256 org.iot.dsa.security
-Stores and verifies passwords using a SHA-256 hash of the text.
-
-DSPath org.iot.dsa.node
-Represents a path in the node tree.
-
-DSPath(String) DSPath
-DSPermission org.iot.dsa.security
-Used to define the required permissions for various objects.
-
-DSPermissionException org.iot.dsa.dslink
-Indicates a request has insufficient permissions.
-
-DSPermissionException() DSPermissionException
-DSPermissionException(String) DSPermissionException
-DSRegistry org.iot.dsa.node
-Static type related meta-data.
-
-DSRegistry() DSRegistry
-DSRequestException org.iot.dsa.dslink
-Indicates something was wrong with a request.
-
-DSRequestException() DSRequestException
-DSRequestException(String) DSRequestException
-DSRuntime org.iot.dsa
-DSA thread pool and timers.
-
-DSRuntime.Timer org.iot.dsa
-Can be used to inspect and cancel tasks passed to the run methods in DSRuntime.
-
-DSStatus org.iot.dsa.node
-Represent the health, quality or condition of an object.
-
-DSString org.iot.dsa.node
-String wrapper.
-
-DSSysNode org.iot.dsa.dslink
-The root of the system nodes.
-
-DSSysNode() DSSysNode
-DSTime org.iot.dsa.time
-Misc time utility functions.
-
-DSTopic org.iot.dsa.node.event
-DSISubscribers subscribe to DSTopics on DSNodes.
-
-DSTopic() DSTopic
-DSUnsupportedException org.iot.dsa.dslink
-Indicates an unsupported method.
-
-DSUnsupportedException() DSUnsupportedException
-DSUnsupportedException(String) DSUnsupportedException
-DSUtil org.iot.dsa.util
-Common utilities.
-
-DSValue org.iot.dsa.node
-A convenience that provides some common default behavior.
-
-DSValue() DSValue
-DSValueNode org.iot.dsa.node
-A convenience implementation of a node that is also a value.
-
-DSValueNode() DSValueNode
-DSValueTopic org.iot.dsa.node.event
-This topic is for change of value events on DSNodes.
-
-DSValueTopic.Event org.iot.dsa.node.event
-The possible events from this topic.
-
-DSValueType org.iot.dsa.node
-These are the primitive types in the DSA protocol.
-
-
-
-
-
-
E
-
-EDITOR DSMetadata
-EMPTY DSString
-The string of length 0.
-
-encode(byte[]) DSBase64
-Encodes the bytes into a single line string with no padding.
-
-encode(byte[], int) DSBase64
-Encodes the buffer into a String with the given line length.
-
-encode(DSIWriter, DSNode) NodeEncoder
-Writes the node tree to the given writer.
-
-encode(byte[]) DSBytes
-encode(byte[]) DSPasswordAes
-Encrypts the given bytes.
-
-encode(String) DSPasswordAes
-Encrypts the given text.
-
-encode(byte[]) DSPasswordSha256
-SHA-256 hash of the bytes encoded as url safe base 64..
-
-encode(String) DSPasswordSha256
-SHA-256 hash of the UTF-8 bytes, encoded as url safe base 64..
-
-encode(long, boolean) DSTime
-Converts a Java Calendar into a DSA encoded timestamp.
-
-encode(long, boolean, StringBuilder) DSTime
-Converts a Java Calendar into a DSA encoded timestamp.
-
-encode(Calendar, boolean, StringBuilder) DSTime
-Converts a Java Calendar into a DSA encoded timestamp.
-
-encodeForFiles(Calendar, StringBuilder) DSTime
-Converts a Java Calendar into a number safe for file names: YYMMDDHHMMSS.
-
-encodeForLogs(Calendar, StringBuilder) DSTime
-Converts a Java Calendar into a shorter human readable timestamp for use in logging files.
-
-encodeKeys() DSKeys
-Encodes the key pair which can be then decoded with decodeKeys().
-
-encodeName(String) DSPath
-Encodes a name for being in a path.
-
-encodeName(String, StringBuilder) DSPath
-Encodes a name for being in a path.
-
-encodeNameV1(String, StringBuilder) DSPath
-Encodes a DSA v1 name for use outside of a path.
-
-encodePath(boolean, String...) DSPath
-Creates a properly encoded path from the given names.
-
-encodePath(boolean, String[], int) DSPath
-Creates a properly encoded path from the given names.
-
-encodePath(DSNode) DSPath
-Ascends the tree and encodes all the node names into a path.
-
-encodePublic() DSKeys
-X9.63 encoding of the public key.
-
-encodePublicHashDsId() DSKeys
-Base64 encoding (no padding and url safe) of the SHA256 hash of the public key.
-
-encodeState() DSInfo
-encodeUrl(byte[]) DSBase64
-Encodes to a URL safe base64 string.
-
-endList() AbstractWriter
-endList() DSIWriter
-End the current list.
-
-endMap() AbstractWriter
-endMap() DSIWriter
-End the current map.
-
-ENUM_RANGE DSMetadata
-equal(Object, Object) DSUtil
-Comparison that takes null into account; null == null.
-
-equals(Object) DSBool
-equals(Object) DSBytes
-True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-equals(Object) DSDouble
-True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-equals(Object) DSFlexEnum
-True if the argument is a DSFlexEnum and the values are equal or they are both isNull.
-
-equals(Object) DSFloat
-True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-equals(Object) DSGroup
-equals(Object) DSInfo
-equals(Object) DSInt
-True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-equals(Object) DSJavaEnum
-True if the argument is a DSDynamicEnum and the values are equal or they are both isNull.
-
-equals(Object) DSLong
-True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-equals(Object) DSMap.Entry
-equals(Object) DSMap
-equals(Object) DSNull
-True of the arg == this.
-
-equals(Object) DSStatus
-equals(Object) DSString
-equals(Object) DSPasswordAes
-equals(Object) DSPasswordSha256
-equals(Object) DSDateTime
-equalsDefault() DSInfo
-True if this proxies a default and the state and value match the default.
-
-equalsDefaultState() DSInfo
-True if the state matches the default state.
-
-equalsDefaultType() DSInfo
-True if this proxies a default and the value type matches the default.
-
-equalsDefaultValue() DSInfo
-True if this proxies a default and the value matches the default.
-
-ERROR DSILevels
-error DSILevels
-error() DSLogger
-True if the level is loggable.
-
-error(Object) DSLogger
-error(Object, Throwable) DSLogger
-ErrorType org.iot.dsa.dslink.requester
-
-
-
-
-
F
-
-FALSE DSBool
-FATAL DSILevels
-fatal DSILevels
-fatal() DSLogger
-True if the level is loggable.
-
-fatal(Object) DSLogger
-fatal(Object, Throwable) DSLogger
-FAULT DSStatus
-Bad, an operational error (exception) has occurred within DSA.
-
-fault DSStatus
-FAULT_STR DSStatus
-FileLogHandler org.iot.dsa.logging
-Logs records to a file.
-
-FINE DSILevels
-fine DSILevels
-fine() DSLogger
-True if the level is loggable.
-
-fine(Object) DSLogger
-Log a frequent event.
-
-fine(Object, Throwable) DSLogger
-Log a frequent event.
-
-fire(DSTopic, DSIEvent, DSInfo) DSNode
-Notifies subscribers of the event.
-
-fire(DSTopic, DSIEvent, DSInfo, Object...) DSNode
-Notifies subscribers of the event.
-
-first() DSGroup
-Returns the item at index 0.
-
-flush() DSIWriter
-Flush the stream.
-
-flush() JsonAppender
-flush() JsonWriter
-flush() AsyncLogHandler
-forString(String) DSPermission
-fromHex(CharSequence) DSBytes
-Converts a hex string into a byte array.
-
-
-
-
-
-
G
-
-generateHmacSHA256Signature(byte[], byte[]) DSKeys
-generateSharedSecret(byte[]) DSKeys
-Uses the given public key to generate an ECDH shared secret.
-
-generateSharedSecret(String) DSKeys
-Uses the given public key to generate an ECDH shared secret.
-
-get(int) DSGroup
-Returns the value at the given index.
-
-get(int, boolean) DSGroup
-Optional getter.
-
-get(int, double) DSGroup
-Optional getter.
-
-get(int, int) DSGroup
-Optional getter.
-
-get(int, long) DSGroup
-Optional getter.
-
-get(int, String) DSGroup
-Optional getter.
-
-get(int) DSList
-get(int) DSMap
-get(String) DSMap
-Returns the value for the given key.
-
-get(String, boolean) DSMap
-Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-get(String, double) DSMap
-Optional getter, returns the provided default if the value mapped to the key is null.
-
-get(String, int) DSMap
-Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-get(String, long) DSMap
-Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-get(String, String) DSMap
-Optional getter, returns the provided default if the value mapped to the key is null.
-
-get(String) DSNode
-Returns the child value with the given name, or null.
-
-getAction() ApiObject
-The action, should only be called if isAction() returns true.
-
-getAction() ActionResult
-The action that was invoked.
-
-getAction() DSActionValues
-getAction() DSInfo
-getBackups() FileLogHandler
-Backup files for this logging, found in the same directory as the active logging.
-
-getBit(int, int) DSUtil
-Returns true if the bit at the given index is set.
-
-getBoolean() AbstractReader
-getBoolean() DSIReader
-Returns the value when last() == BOOLEAN.
-
-getBoolean(int) DSGroup
-Primitive getter.
-
-getBoolean(String) DSMap
-Primitive getter.
-
-getBooleanRange() DSMetadata
-The boolean range, or null.
-
-getBrokerUri() DSLinkConfig
-If not set, will look for the getConfig in dslink.json.
-
-getBytes() AbstractReader
-getBytes() DSIReader
-Returns the value when last() == BYTES.
-
-getBytes() DSBytes
-The raw bytes, do not modify.
-
-getCalendar() DSTime
-Attempts to reuse a calendar instance, the timezone will be set to TimeZone.getDefault().
-
-getCalendar(long) DSTime
-Attempts to reuse a calendar instance and sets the time in millis to the argument and the
- timezone to TimeZone.getDefault().
-
-getCause() DSException
-getChildren() ApiObject
-Iterator of child objects, should only be called if hasChildren() returns true.
-
-getChildren() DSInfo
-getColumns() ActionTable
-Column definitions, optional but highly recommended.
-
-getConfig() DSLink
-getConfig(String, boolean) DSLinkConfig
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-getConfig(String, double) DSLinkConfig
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-getConfig(String, int) DSLinkConfig
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-getConfig(String, long) DSLinkConfig
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-getConfig(String, String) DSLinkConfig
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-getConnection() DSLink
-getConnection() DSSysNode
-getConnectionId() DSLinkConnection
-A unique descriptive tag such as a combination of the link name and the broker host.
-
-getDecimalPlaces() DSMetadata
-The decimal precision or null.
-
-getDecoder(Class) DSRegistry
-The instance to use for decoding.
-
-getDefault() DSMetadata
-The default value for an action parameter, or null.
-
-getDefaultLogger() DSLogging
-The default logger.
-
-getDefaultObject() DSInfo
-If this represents a dynamic child, this just returns the current value.
-
-getDepth() AbstractWriter
-Current depth in the tree, will be needed by writeNewLineIndent.
-
-getDescription() DSMetadata
-The description, or null.
-
-getDetail() DSRequestException
-Additional information to supply to the remote endpoint.
-
-getDisplayName() DSMetadata
-The alternate display name, or null.
-
-getDouble() AbstractReader
-getDouble() DSIReader
-Returns the value when last() == DOUBLE.
-
-getDouble(int) DSGroup
-Primitive getter.
-
-getDouble(String) DSMap
-Primitive getter.
-
-getDsaVersion() DSLinkConfig
-getDsId() DSLink
-Returns the unique id of the connection.
-
-getDslinkJson() DSLinkConfig
-If not set, this will attempt to open dslink.json in the working the process directory.
-
-getEditor() DSMetadata
-The editor, or null.
-
-getElement() AbstractReader
-getElement() DSIReader
-Returns the DSElement when last() == raw type or ROOT.
-
-getElement() DSInfo
-A convenience that casts getObject().
-
-getElement(String) DSNode
-A convenience for (DSElement) get(name).
-
-getElementType() DSBool
-getElementType() DSBytes
-getElementType() DSDouble
-getElementType() DSElement
-For switch statements.
-
-getElementType() DSList
-getElementType() DSLong
-getElementType() DSMap
-getElementType() DSNull
-getElementType() DSString
-getEntry(int) DSMap
-getEntry(String) DSMap
-getEnumRange() DSMetadata
-The editor, or null.
-
-getEnums(DSList) DSFlexEnum
-getEnums(DSList) DSIEnum
-Adds the range of possible values to the given bucket.
-
-getEnums(DSList) DSJavaEnum
-getFirst() DSNode
-The first child, or null.
-
-getFirstInfo() DSNode
-The first child info, or null.
-
-getFirstNodeInfo() DSNode
-The info for the first child node, or null.
-
-getFloat(int) DSGroup
-Primitive getter.
-
-getHandler(File) FileLogHandler
-Will return an existing handler for the given file, or create a new one.
-
-getHelpText() DSLinkConfig
-Help text for command line options.
-
-getHouseKeepingIntervalMillis() AsyncLogHandler
-Ten seconds by default, this is a guideline more than anything else.
-
-getInfo() DSNode
-DSInfo for this node in its parent, or null if un-parented.
-
-getInfo(String) DSNode
-Returns the info for the child with the given name, or null.
-
-getInt(int) DSGroup
-Primitive getter.
-
-getInt(String) DSMap
-Primitive getter.
-
-getInterval() DSRuntime.Timer
-The interval between runs, zero or less for no interval.
-
-getKey() DSMap.Entry
-getKey(int) DSMap
-Returns the key at the given index.
-
-getKeys() DSLink
-Public / private keys of the link, used to prove identity with brokers.
-
-getKeys() DSLinkConfig
-If not set, will attempt to use the getConfig in dslink.json and fall back to '.key' in the
- process directory if necessary.
-
-getKeys() DSKeys
-The public and private keys.
-
-getLast() DSNode
-The last child, or null.
-
-getLastInfo() DSNode
-The last child info, or null.
-
-getLastPathElement() DSPath
-getLevel() DSPermission
-getLink() DSLinkConnection
-The link using this connection.
-
-getLink() DSMainNode
-The parent link or null.
-
-getLink() DSSysNode
-getLinkName() DSLink
-As defined in dslink.json.
-
-getLinkName() DSLinkConfig
-getList() AbstractReader
-getList() DSIReader
-This should only be called when last() == BEGIN_LIST and it will decodeKeys the entire
- list.
-
-getList(int) DSGroup
-Primitive getter.
-
-getList(String) DSMap
-Return the list, or null.
-
-getLocalizedMessage() DSException
-getLogger(String, File) DSLogging
-Adds a FileLogHandler to the named logger, if there isn't one already.
-
-getLogLevel() DSLinkConfig
-If not set, will attempt to use the getConfig in dslink.json but fall back to 'info' if
- necessary.
-
-getLogName() DSLink
-getLogName() DSLinkConnection
-getLogName() DSMainNode
-getLogName() DSSysNode
-getLogName() DSLogger
-Override point, returns the simple class name by default.
-
-getLogName() DSNode
-getLong() AbstractReader
-getLong() DSIReader
-Returns the value when last() == LONG.
-
-getLong(int) DSGroup
-Primitive getter.
-
-getLong(String) DSMap
-Primitive getter.
-
-getMain() DSLink
-getMainType() DSLinkConfig
-The type of the root node.
-
-getMap() AbstractReader
-getMap() DSIReader
-This should only be called when last() == BEGIN_MAP and it will decodeKeys the entire map.
-
-getMap(int) DSGroup
-Primitive getter.
-
-getMap(String) DSMap
-Returns the map value for the given key, or null.
-
-getMap() DSMetadata
-getMaxBackups() FileLogHandler
-The number of backup files to retain.
-
-getMaxValue() DSMetadata
-The max value, or null.
-
-getMessage() DSException
-getMetadata(DSMap) ApiObject
-getMetadata(DSMap) DSFlexEnum
-getMetadata(DSMap) DSIMetadata
-The entity should add any metadata about itself to the given map.
-
-getMetadata(DSMap) DSInfo
-getMetadata(DSMap) DSJavaEnum
-getMetadata(DSInfo, DSMap) DSMetadata
-Fully acquires metadata about the info.
-
-getMetadata(DSInfo, DSMap) DSNode
-Override point, add any meta data for the given info to the provided bucket.
-
-getMinValue() DSMetadata
-The min value, or null.
-
-getName() ApiObject
-The display name.
-
-getName() DSInfo
-getName() DSMetadata
-The name, or null.
-
-getName() DSNode
-Returns the name of this node in its parent, or null if un-parented.
-
-getNode() DSInfo
-A convenience that casts getObject().
-
-getNode(String) DSNode
-A convenience for (DSNode) get(name).
-
-getNodesFile() DSLinkConfig
-If not set, will attempt to use the getConfig in dslink.json but fall back to 'nodes.zip' in
- the process directory if necessary.
-
-getObject() DSInfo
-getOut() AsyncLogHandler
-The sink for formatted messages.
-
-getParameters() ActionInvocation
-The parameters supplied by the requester, or null.
-
-getParameters() ActionSpec
-Returns an iterator for each parameter.
-
-getParameters() DSAction
-getParameters() DSKeys
-The AlgorithmParameterSpec for the predefined elliptic curve secp256r1.
-
-getParams() AbstractInvokeHandler
-Returns the value passed to onInit.
-
-getParent() DSInfo
-getParent() DSNode
-Returns the parent node, or null.
-
-getPath() AbstractInvokeHandler
-Returns the value passed to onInit.
-
-getPath() AbstractListHandler
-Returns the value passed to onInit.
-
-getPath() AbstractSubscribeHandler
-Returns the value passed to onInit.
-
-getPath() InboundRequest
-The target of the request.
-
-getPath() DSNode
-The DSA path, properly encoded.
-
-getPath() DSPath
-The raw fully encoded path.
-
-getPathElements() DSPath
-The individual, decoded path elements.
-
-getPermission() InboundSetRequest
-The permission to set with.
-
-getPermission() ActionInvocation
-The permission level of the invoker, should be verified against the permission level required
- by the action.
-
-getPermission() ActionSpec
-Minimum permission level required to invoke.
-
-getPermission() DSAction
-Not used.
-
-getPlaceHolder() DSMetadata
-Placeholder text for text fields, or null.
-
-getPrivateKey() DSKeys
-A convenience that casts the private key.
-
-getPublicKey() DSKeys
-A convenience that casts the public key.
-
-getQos() AbstractSubscribeHandler
-Returns the value passed to onInit.
-
-getRequester() DSLinkConnection
-getRequestId() InboundRequest
-Unique ID of the request, or 0 for subscriptions.
-
-getResult(long) SimpleInvokeHandler
-Waits for the stream to close before returning, or the timeout to occur.
-
-getResultType() ActionSpec
-What the action returns.
-
-getResultType() DSAction
-getRows() ActionTable
-This should return an iterator for the initial set of rows, or null if there aren't any.
-
-getRunnable() DSRuntime.Timer
-The runnable being managed by this timer.
-
-getSession() DSLinkConnection
-getSignature() DSKeys.Signer
-The signature for all bytes passed to the update method.
-
-getSignatureBase64() DSKeys.Signer
-The base 64 encoding of the signature for all bytes passed to the update method.
-
-getStackTrace() DSException
-getStream() AbstractInvokeHandler
-Returns the value passed to onInit.
-
-getStream() AbstractListHandler
-Returns the value passed to onInit.
-
-getStream() AbstractSubscribeHandler
-Returns the value passed to onInit.
-
-getString() AbstractReader
-getString() DSIReader
-Returns the value when last() == STRING.
-
-getString(int) DSGroup
-Primitive getter.
-
-getString(String) DSMap
-Returns the String value for the given key, or null.
-
-getSubscriptionId() InboundSubscribeRequest
-Unique subscription id for this path.
-
-getSys() DSLink
-getSys() DSLinkConnection
-getTarget() OutboundListResponse
-The object that represents the path of the request.
-
-getThreadName() AsyncLogHandler
-Used to name the thread that processes logging records.
-
-getThreadName() FileLogHandler
-getThreadName() PrintStreamLogHandler
-getToken() DSLinkConfig
-Authentication token for the broker, this can return null.
-
-getTransport() DSLinkConnection
-getType() DSMetadata
-The type for action parameters, can be used to override types in the responder api.
-
-getUnit() DSMetadata
-Value if defined, otherwise null.
-
-getValue() ApiObject
-Value of the object, should only be called if isValue() returns true.
-
-getValue() InboundSetRequest
-The value to set.
-
-getValue() DSInfo
-A convenience that casts getObject().
-
-getValue() DSMap.Entry
-getValue(String) DSNode
-A convenience for (DSIValue) get(name).
-
-getValueChild() DSValueNode
-Subclasses must store the node value in a child value and provide the info for that child
- here.
-
-getValueResults() ActionSpec
-This is only called for the VALUES result type.
-
-getValueResults() DSAction
-getValues() ActionValues
-getValues() DSActionValues
-getValueType() DSBool
-getValueType() DSBytes
-getValueType() DSDouble
-getValueType() DSElement
-The DSA value type mapping.
-
-getValueType() DSFlexEnum
-getValueType() DSFloat
-getValueType() DSInt
-getValueType() DSIValue
-The DSA type mapping.
-
-getValueType() DSJavaEnum
-getValueType() DSList
-getValueType() DSLong
-getValueType() DSMap
-getValueType() DSNull
-getValueType() DSStatus
-String.
-
-getValueType() DSString
-getValueType() DSValueNode
-getValueType() DSPasswordAes
-getValueType() DSPasswordSha256
-getValueType() DSDateTime
-String.
-
-
-
-
-
-
H
-
-hasChildren() ApiObject
-True if getChildren() can be called.
-
-hasChildren() DSInfo
-hashCode() DSBool
-hashCode() DSBytes
-hashCode() DSDouble
-hashCode() DSFlexEnum
-hashCode() DSFloat
-hashCode() DSGroup
-hashCode() DSInfo
-hashCode() DSInt
-hashCode() DSJavaEnum
-hashCode() DSLong
-hashCode() DSMap.Entry
-hashCode() DSMap
-hashCode() DSStatus
-hashCode() DSString
-hashCode() DSPasswordAes
-hashCode() DSPasswordSha256
-hashCode() DSDateTime
-hasNext() DSInfo
-True if there is another info after this one.
-
-hasParent() DSGroup
-houseKeeping() AsyncLogHandler
-Subclass hook for activities such as rolling files and cleaning up old garbage.
-
-houseKeeping() FileLogHandler
-
-
-
-
-
I
-
-InboundInvokeRequest org.iot.dsa.dslink.responder
-See ActionInvocation for the real meat.
-
-InboundListRequest org.iot.dsa.dslink.responder
-The details about an incoming list request passed to the responder.
-
-InboundRequest org.iot.dsa.dslink.responder
-Common to all incoming requests.
-
-InboundSetRequest org.iot.dsa.dslink.responder
-InboundSubscribeRequest org.iot.dsa.dslink.responder
-The details about an incoming subscribe request passed to the responder.
-
-indexOf(DSElement) DSGroup
-Scans the collection and returns the first index that equal the arg.
-
-indexOf(String) DSMap
-Index of the given key, or -1.
-
-INFO DSILevels
-info DSILevels
-info() DSLogger
-True if the level is loggable.
-
-info(Object) DSLogger
-Log an infrequent major lifecycle event.
-
-info(Object, Throwable) DSLogger
-Log an infrequent major lifecycle event.
-
-INFO_TOPIC DSNode
-init(DSLinkConfig) DSLink
-Configures a link instance including creating the appropriate connection.
-
-initCause(Throwable) DSException
-insert(int, DSList...) ActionInvocation
-Only use with open tables, insert the rows at the given index.
-
-INSTANCE DSInfoTopic
-The only instance of this topic.
-
-INSTANCE DSValueTopic
-The only instance of this topic.
-
-invoke(String, DSMap, OutboundInvokeHandler) DSIRequester
-Submits an invoke request.
-
-invoke(DSInfo, ActionInvocation) DSAction
-Calls onInvoke on the proper node.
-
-isAction() ApiObject
-True if the object is an action.
-
-isAction() DSInfo
-isAdmin() ApiObject
-Whether or not this object requires configuration permission to read/write.
-
-isAdmin() DSInfo
-isAutoClose() SimpleInvokeHandler
-True by default, whether or not to close the stream upon receiving the first result.
-
-isBad() DSStatus
-If any of the bad flags are set, or is null.
-
-isBoolean() DSBool
-isBoolean() DSElement
-Whether or not the object represents a boolean.
-
-isBytes() DSBytes
-isBytes(String) DSBytes
-True if the string starts with the DSA escape sequence for a base 64 encoded string.
-
-isBytes() DSElement
-Whether or not the object represents a byte array.
-
-isCancelled() DSRuntime.Timer
-isClosed() ActionSpec.ResultType
-True if CLOSED_TABLE, VOID, or VALUES.
-
-isConfig() DSPermission
-isConfigFault() DSStatus
-True if the associate bit is set.
-
-isConnected() DSLinkConnection
-True when a connection is established with the remote endpoint.
-
-isDefaultInstance() DSNode
-True if this is the default instance for the type.
-
-isDefaultOnCopy() DSInfo
-Whether or not the current value, or the default value is copied.
-
-isDisabled() DSStatus
-True if the associate bit is set.
-
-isDouble() DSDouble
-isDouble() DSElement
-Whether or not the object represents a double.
-
-isDouble() DSFloat
-isDouble() DSInt
-isDouble() DSINumber
-Whether or not the object represents a double.
-
-isDown() DSStatus
-True if the associate bit is set.
-
-isDynamic() DSInfo
-Whether or not this info represents a declared default.
-
-isEmpty() DSGroup
-Returns true when childCount() == 0.
-
-isEmpty() DSMetadata
-isEqual(Object) DSAction
-Defaults to the equals method.
-
-isEqual(Object) DSElement
-isEqual(Object) DSFlexEnum
-isEqual(Object) DSFloat
-isEqual(DSInfo) DSInfo
-True if the flags and target object are equal (not identical if the target is a node).
-
-isEqual(Object) DSInt
-isEqual(Object) DSIObject
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-isEqual(Object) DSJavaEnum
-isEqual(Object) DSNode
-True if the argument is a node with the same children, although their order can be
- different.
-
-isEqual(Object) DSStatus
-isEqual(Object) DSTopic
-Only test instance equality.
-
-isEqual(Object) DSPasswordAes
-isEqual(Object) DSPasswordSha256
-isEqual(Object) DSDateTime
-Defaults to the equals method.
-
-isFault() DSStatus
-True if the associate bit is set.
-
-isFinished() DSRuntime.Timer
-True if cancelled or was a one time execution and that has finished.
-
-isFloat() DSElement
-Whether or not the object represents a float.
-
-isFloat() DSFloat
-isFloat() DSInt
-isFloat() DSINumber
-Whether or not the object represents a double.
-
-isGood() DSStatus
-If true, any associate object / value can be trusted.
-
-isGreaterThan(DSPermission) DSPermission
-True if this level is higher than the given.
-
-isGroup() DSElement
-Whether or not the object represents a list or map.
-
-isGroup() DSGroup
-isHidden() ApiObject
-True if the object should ignored (not be exposed through the api).
-
-isHidden() DSInfo
-Whether or not an object is visible to clients.
-
-isIdentical(DSInfo) DSInfo
-True if the flags and target object are identical.
-
-isIdentical(Object) DSNode
-True if the argument is a node with the same children in the exact same order.
-
-isInfinite() DSDouble
-isInt() DSElement
-Whether or not the object represents an int.
-
-isInt() DSFloat
-isInt() DSInt
-isInt() DSINumber
-Whether or not the object represents an int.
-
-isList() DSElement
-Whether or not the object represents a list.
-
-isList() DSList
-Returns true.
-
-isList() DSPermission
-isLong() DSElement
-Whether or not the object represents a long.
-
-isLong() DSFloat
-isLong() DSInt
-isLong() DSINumber
-Whether or not the object represents a long.
-
-isLong() DSLong
-isMap() DSElement
-Whether or not the object represents a amp.
-
-isMap() DSMap
-Returns true.
-
-isNaN() DSDouble
-isNode() DSInfo
-Whether or not the object is a DSNode.
-
-isNode(Object) DSNode
-Convenience for instanceof DSNode.
-
-isNull() DSAction
-False
-
-isNull() DSBool
-isNull() DSBytes
-isNull() DSDouble
-isNull() DSElement
-Whether or not the object represents null.
-
-isNull() DSFlexEnum
-isNull() DSFloat
-isNull(int) DSGroup
-Whether or not the object at the given index is null.
-
-isNull() DSInt
-isNull() DSIObject
-isNull() DSIValue
-Values should have an instance representing null.
-
-isNull() DSJavaEnum
-isNull() DSList
-Returns false.
-
-isNull() DSLong
-isNull() DSMap
-Returns false.
-
-isNull(String) DSMap
-Returns true if the key isn't in the map, or it's value is null.
-
-isNull() DSNode
-Returns false.
-
-isNull() DSNull
-True
-
-isNull() DSStatus
-isNull() DSTopic
-False
-
-isNull() DSPasswordAes
-isNull() DSPasswordSha256
-isNull() DSDateTime
-isNumber() DSDouble
-isNumber() DSElement
-Whether or not the object represents a number.
-
-isNumber() DSLong
-isOk() DSStatus
-isOpen() InboundListRequest
-Whether or not the list stream is still open.
-
-isOpen() ActionInvocation
-Whether or not response is still open.
-
-isOpen() ActionSpec.ResultType
-True if OPEN_TABLE or STREAM_TABLE
-
-isOverride() DSStatus
-True if the associate bit is set.
-
-isRead() DSPermission
-isReadOnly() ApiObject
-True if the object is a value and cannot be written.
-
-isReadOnly() DSInfo
-Whether or not an object can be written by a client.
-
-isRemoteConfigFault() DSStatus
-isRemoteDisabled() DSStatus
-isRemoteDown() DSStatus
-isRemoteFault() DSStatus
-isRemoteOverride() DSStatus
-isRemoteStale() DSStatus
-isRemoteUnknown() DSStatus
-isRequester() DSMainNode
-Override point, returns true by default.
-
-isResponder() DSMainNode
-Override point, returns true by default.
-
-isRunning() DSRuntime.Timer
-True when the runnable is being actually being executed.
-
-isRunning() DSNode
-A convenience for !isStopped().
-
-isStable() DSNode
-True after stable is called, children are stable before their parents.
-
-isStale() DSStatus
-isStarted() DSNode
-True after start is called, children are started before their parents.
-
-isStopped() DSNode
-True after stop is called, children are stopped before their parents.
-
-isStream() ActionSpec.ResultType
-True if this is the STREAM_TABLE.
-
-isStreamOpen() OutboundStream
-Whether or not the request is open.
-
-isString() DSElement
-Whether or not the object represents a string.
-
-isString() DSString
-isSubscribed() DSNode
-True if there are any subscribers.
-
-isSubscribed(DSInfo, DSTopic) DSNode
-True if there are any subscriptions with the matching child and topic.
-
-isSubscribed(DSTopic) DSNode
-True if there any subscriptions for the given topic.
-
-isTransient() DSInfo
-Whether or not an object is persistent.
-
-isUnknown() DSStatus
-isValid(DSElement) DSIPassword
-Returns true if the give element is valid according to the backing implementation.
-
-isValid(DSElement) DSPasswordAes
-Encrypts the string value of the given element and compares against the value stored in this
- object.
-
-isValid(String) DSPasswordAes
-Encrypts the given string and compares against the value stored in this object.
-
-isValid(DSElement) DSPasswordSha256
-Hashes the string value of the given element and compares against the hash stored in this
- object.
-
-isValid(String) DSPasswordSha256
-Hashes the given string and compares against the value stored in this object.
-
-isValue() ApiObject
-True if getValue() can be called.
-
-isValue() DSInfo
-isValues() ActionSpec.ResultType
-isVoid() ActionSpec.ResultType
-isWrite() DSPermission
-isZip() JsonAppender
-Whether or not this is zipping the output.
-
-iterateNodes() DSNode
-Returns an info iterator of child DSNodes.
-
-iterateValues() DSNode
-Returns an info iterator of child DSIValues.
-
-iterator() DSList
-Returns an iterator that does not implement remove.
-
-iterator() DSNode
-Returns an info iterator of all children.
-
-
-
-
-
-
J
-
-JsonAppender org.iot.dsa.io.json
-Json implementation of DSWriter intended for Appendables such as StringBuilders.
-
-JsonAppender() JsonAppender
-Be sure to call one of the setOutput methods.
-
-JsonAppender(Appendable) JsonAppender
-Will write directly to the given appendable.
-
-JsonAppender(File) JsonAppender
-Creates an underlying FileWriter.
-
-JsonAppender(File, String) JsonAppender
-Will create a zip file using the zipFileName as file name inside the zip.
-
-JsonAppender(OutputStream) JsonAppender
-Creates an underlying OutputStreamWriter.
-
-JsonAppender(OutputStream, String) JsonAppender
-Will write a zip file to the given stream.
-
-JsonConstants org.iot.dsa.io.json
-Useful constants.
-
-JsonReader org.iot.dsa.io.json
-Json implementation of DSReader.
-
-JsonReader() JsonReader
-JsonReader(CharSequence) JsonReader
-JsonReader(File) JsonReader
-JsonReader(InputStream, String) JsonReader
-JsonReader(Reader) JsonReader
-JsonWriter org.iot.dsa.io.json
-Json implementation of DSWriter intended for OutputStreams and Writers.
-
-JsonWriter() JsonWriter
-Be sure to call one of the setOutput methods.
-
-JsonWriter(File) JsonWriter
-Creates an underlying FileWriter.
-
-JsonWriter(File, String) JsonWriter
-Will create a zip file using the zipFileName as file name inside the zip.
-
-JsonWriter(OutputStream) JsonWriter
-Creates an underlying OutputStreamWriter.
-
-JsonWriter(OutputStream, String) JsonWriter
-Will write a zip file to the given stream.
-
-JsonWriter(Writer) JsonWriter
-
-
-
-
-
K
-
-key(CharSequence) AbstractWriter
-key(CharSequence) DSIWriter
-Write a key in the current map.
-
-keys DSMap
-For preserving order.
-
-
-
-
-
-
L
-
-last() AbstractReader
-last() DSIReader
-The last value returned from next().
-
-last() DSGroup
-Returns the item at the highest index.
-
-lastIndexOf(DSElement) DSGroup
-Scans the collection and returns the first index that equal the arg.
-
-lastRun() DSRuntime.Timer
-The lastRun run or -1 if it hasn't run yet.
-
-length() AbstractWriter
-Returns 0 by default.
-
-length() DSIWriter
-If the writer is buffering output, this returns the size of that buffer.
-
-length() DSBytes
-The number of bytes in the array.
-
-list(String, OutboundListHandler) DSIRequester
-Submits a list request.
-
-list DSList
-load(DSLinkConfig) DSLink
-Creates a link by first testing for an existing serialized database.
-
-
-
-
-
-
M
-
-main(String[]) DSLink
-This is a convenience for DSLink.load(new DSLinkConfig(args)).run() and can be used as the
- the main class for any link.
-
-make(boolean) DSElement
-Creates an DSIObject representation of the primitive.
-
-make(byte[]) DSElement
-Creates an DSIObject representation of the primitive.
-
-make(double) DSElement
-Creates an DSIObject representation of the primitive.
-
-make(int) DSElement
-Creates an DSIObject representation of the primitive.
-
-make(long) DSElement
-Creates an DSIObject representation of the primitive.
-
-make(String) DSElement
-Creates an DSIObject representation of the primitive.
-
-makeBackup() FileLogHandler
-Only public for testing, do not call.
-
-makeException(ErrorType, String) ErrorType
-makeMessage(Throwable) DSException
-Attempts come up with the best description of the argument.
-
-makeNull() DSElement
-Creates an DSIObject representation of null.
-
-makeRuntime(Throwable) DSException
-If the given exception is already a runtime exception, it is cast and returned,
- otherwise it will be returned wrapped by an instance of this class.
-
-map DSMap
-MAX_VALUE DSMetadata
-millis() DSInterval
-The approximate number of ms in the interval.
-
-MILLIS_DAY DSTime
-MILLIS_FIFTEEN_MINUTES DSTime
-MILLIS_FIFTEEN_SECONDS DSTime
-MILLIS_FIVE_MINUTES DSTime
-MILLIS_FIVE_SECONDS DSTime
-MILLIS_FOUR_HOURS DSTime
-MILLIS_HOUR DSTime
-MILLIS_MINUTE DSTime
-MILLIS_MONTH DSTime
-MILLIS_QUARTER DSTime
-MILLIS_SECOND DSTime
-MILLIS_SIX_HOURS DSTime
-MILLIS_TEN_MINUTES DSTime
-MILLIS_TEN_SECONDS DSTime
-MILLIS_THIRTY_MINUTES DSTime
-MILLIS_THIRTY_SECONDS DSTime
-MILLIS_THREE_HOURS DSTime
-MILLIS_TWELVE_HOURS DSTime
-MILLIS_TWENTY_MINUTES DSTime
-MILLIS_TWO_HOURS DSTime
-MILLIS_WEEK DSTime
-MILLIS_YEAR DSTime
-millisToNanos(long) DSTime
-MIN_VALUE DSMetadata
-
-
-
-
-
N
-
-NAME DSMetadata
-NANOS_IN_MS DSTime
-NANOS_IN_SEC DSTime
-nanosToMillis(long) DSTime
-newKeyPair() DSKeys
-Creates a key pair for the predefined elliptic curve secp256r1.
-
-newSignature() DSKeys
-Returns a SHA256withECDSA signature.
-
-newSigner() DSKeys
-Creates a signer for this private key.
-
-newVerifier() DSKeys
-Creates a verifier for this public key.
-
-next() AbstractReader
-Subclasses must override this, read the next item from the stream, then call one of the
- setXxx methods.
-
-next() DSIReader
-Advances the reader to the next item and returns the token representing it's current state.
-
-next() JsonReader
-next() DSInfo
-The next info in the parent node.
-
-next(long) DSInterval
-Returns the nextRun interval for the previously aligned timestamp.
-
-nextAction() DSInfo
-The next DSInfo in the parent that is an action, or null.
-
-nextNode() DSInfo
-The next DSInfo in the parent that is a node, or null.
-
-nextRun() DSRuntime.Timer
-The next scheduled time to run.
-
-nextValue() DSInfo
-The next DSInfo in the parent that is a value, or null.
-
-NodeDecoder org.iot.dsa.io
-Decodes a node (tree) that was encoded with NodeEncoder.
-
-NodeEncoder org.iot.dsa.io
-Encodes a node tree using a compact JSON schema.
-
-NULL DSBool
-NULL DSBytes
-NULL DSDouble
-NULL DSFlexEnum
-NULL DSFloat
-NULL DSInt
-NULL DSJavaEnum
-NULL DSLong
-NULL DSNull
-NULL DSStatus
-NULL DSString
-NULL DSPasswordAes
-NULL DSPasswordSha256
-NULL DSDateTime
-
-
-
-
-
O
-
-off DSILevels
-OK DSStatus
-Good, no other status applies.
-
-ok DSStatus
-OK_OVERRIDE DSStatus
-Good, the value is overridden within DSA.
-
-OK_OVERRIDE_STR DSStatus
-OK_REMOTE_OVERRIDE DSStatus
-Good, the value is overridden outside of DSA.
-
-OK_REMOTE_OVERRIDE_STR DSStatus
-OK_STR DSStatus
-okOverride DSStatus
-okRemoteOverride DSStatus
-onChildAdded(DSInfo) DSNode
-Called when the given child is added and in the stable state.
-
-onChildChanged(DSInfo) DSNode
-Called when the given child is changed and in the stable state.
-
-onChildChanged(DSInfo) DSValueNode
-This fires the NODE_CHANGED topic when the value child changes.
-
-onChildRemoved(DSInfo) DSNode
-Called when the given child is removed and in the stable state.
-
-onClose() OutboundRequestHandler
-Callback for when the request stream is closed, no matter how or by who.
-
-onClose() SimpleInvokeHandler
-Causes getResult to return.
-
-onClose() SimpleRequestHandler
-Does nothing by default.
-
-onClose() OutboundListResponse
-Will be called no matter how the stream is closed.
-
-onClose(Integer) SubscriptionCloseHandler
-Will be called no matter how the subscription is terminated.
-
-onClose() ActionResult
-Always called, whether or not the result is a stream, and no matter who closes it.
-
-onClose() DSActionValues
-Does nothing.
-
-onColumns(DSList) OutboundInvokeHandler
-Called whenever columns are received.
-
-onColumns(DSList) SimpleInvokeHandler
-Does nothing.
-
-onConnect(DSLinkConnection) DSLinkConnection.Listener
-Called asynchronously after the connection with the endpoint is opened.
-
-onConnect() DSLinkConnection
-Called after onInitialize and before onRun.
-
-onDisconnect(DSLinkConnection) DSLinkConnection.Listener
-Called synchronously after the connection with the endpoint is closed.
-<<<<<<< HEAD
-
-onDisconnect() DSLinkConnection
-Called when this network connection has been closed.
-
-=======
-
-onDisconnect() DSLinkConnection
-Called when this network connection has been closed.
-
->>>>>>> 22064982f1faddb35f2da7c8a183dbbc8602cbe9
-onError(ErrorType, String) OutboundRequestHandler
-Callback for when an error is received.
-
-onError(ErrorType, String) SimpleInvokeHandler
-Will create an exception to be thrown by getResult.
-
-onError(ErrorType, String) SimpleRequestHandler
-Does nothing by default.
-
-onEvent(DSTopic, DSIEvent, DSNode, DSInfo, Object...) DSISubscriber
-Subscription callback.
-
-onInfoChanged(DSInfo) DSNode
-Called when the given info is modified and in the stable state.
-
-onInit(String, DSMap, OutboundStream) AbstractInvokeHandler
-Sets the fields so they can be access via the corresponding getters.
-
-onInit(String, OutboundStream) AbstractListHandler
-Sets the fields so they can be accessed with the corresponding getters.
-
-onInit(String, int, OutboundStream) AbstractSubscribeHandler
-Sets the fields so they can be accessed via the corresponding getters.
-
-onInit(String, DSMap, OutboundStream) OutboundInvokeHandler
-Called by the requester before returning from the invoke method.
-
-onInit(String, OutboundStream) OutboundListHandler
-Called by the requester before returning from the list method.
-
-onInit(String, int, OutboundStream) OutboundSubscribeHandler
-Called by the requester before returning from the subscribe method.
-
-onInitialize() DSLinkConnection
-Always called before onConnect.
-
-onInitialized() OutboundListHandler
-Called once the initial state of the target has been transmitted.
-
-onInsert(int, DSList) OutboundInvokeHandler
-Called when the given rows should be inserted at the given index.
-
-onInsert(int, DSList) SimpleInvokeHandler
-Will result in an error since tables and streams are not supported.
-
-onInvoke(InboundInvokeRequest) DSIResponder
-The implementation should quickly create an object for responding to the request, but do no
- processing of it on the calling thread.
-
-onInvoke(DSInfo, ActionInvocation) DSSysNode
-onInvoke(DSInfo, ActionInvocation) DSNode
-Override point, called by the default implementation of DSAction.invoke.
-
-onList(InboundListRequest) DSIResponder
-The implementation should quickly create an object for responding to the request, but do no
- processing of it on the calling thread.
-
-onMode(OutboundInvokeHandler.Mode) OutboundInvokeHandler
-Called whenever a mode is received.
-
-onMode(OutboundInvokeHandler.Mode) SimpleInvokeHandler
-Does nothing.
-
-onRemove(String) OutboundListHandler
-Only called after onOpen(), indicates something about the target of the request has been
- removed.
-
-onReplace(int, int, DSList) OutboundInvokeHandler
-The rows starting and ending with the given indexes should be removed and the given rows
- inserted at the start index.
-
-onReplace(int, int, DSList) SimpleInvokeHandler
-Will result in an error since tables and streams are not supported.
-
-onRun() DSLinkConnection
-The long term management of the connection (reading and writing).
-
-onSet(InboundSetRequest) DSIResponder
-The implementation should do no processing of it on the calling thread.
-
-onSet(DSInfo, DSIValue) DSNode
-Override point, called when a value being set.
-
-onSet(DSIValue) DSNode
-Override point, called only when a DSNode subclass implements DSIValue is being set.
-
-onSet(DSIValue) DSValueNode
-onStable() DSLinkConnection
-Starts the connection.
-
-onStable() DSNode
-Called once this node is stable, but before stable is called on children.
-
-onStarted() DSNode
-Called once this node and its entire subtree is started.
-
-onStopped() DSLink
-onStopped() DSNode
-Called once this node and its entire subtree is stopped.
-
-onSubscribe(InboundSubscribeRequest) DSIResponder
-The implementation should quickly create an object for responding to the request, but do no
- processing of it on the calling thread.
-
-onSubscribe(DSTopic, DSInfo, DSISubscriber) DSNode
-Called for every subscription.
-
-onSubscribed() DSNode
-Called when this node transitions from having no subscriptions to having a subscription of
- any kind.
-
-onSubscribed(DSTopic, DSInfo) DSNode
-Called when the child and topic pair transitions from having no subscriptions to have a
- subscription.
-
-onTableMeta(DSMap) OutboundInvokeHandler
-Called whenever metadata for the entire table is received.
-
-onTableMeta(DSMap) SimpleInvokeHandler
-onUnsubscribe(DSTopic, DSInfo, DSISubscriber) DSNode
-Called for every unsubscribe.
-
-onUnsubscribed() DSNode
-Called when this node transitions to having no subscriptions of any kind.
-
-onUnsubscribed(DSTopic, DSInfo) DSNode
-Called when the child and topic pair transitions to having no subscriptions.
-
-onUnsubscribed(DSTopic, DSNode, DSInfo) DSISubscriber
-Called no matter how the unsubscribe happens, whether explicitly or if the node
- unsubscribes itself.
-
-onUpdate(DSList) OutboundInvokeHandler
-Called for every row.
-
-onUpdate(String, DSElement) OutboundListHandler
-Called to provide a value for node metadata, attribute or child.
-
-onUpdate(DSDateTime, DSElement, DSStatus) OutboundSubscribeHandler
-Subscription update mechanism.
-
-onUpdate(DSList) SimpleInvokeHandler
-Captures the result and if auto-close is true, closes the stream.
-
-org.iot.dsa - package org.iot.dsa
-Use the DSRuntime thread pool and timers.
-
-org.iot.dsa.dslink - package org.iot.dsa.dslink
-DSLink is the main entry point for an application.
-
-org.iot.dsa.dslink.requester - package org.iot.dsa.dslink.requester
-API for implementing requesters without having to modeling everything in the node tree.
-
-org.iot.dsa.dslink.responder - package org.iot.dsa.dslink.responder
-API for implementing responders without having modeling everything in the node tree.
-
-org.iot.dsa.io - package org.iot.dsa.io
-Node serialization and streaming abstraction for JSON and MsgPack.
-
-org.iot.dsa.io.json - package org.iot.dsa.io.json
-org.iot.dsa.logging - package org.iot.dsa.logging
-Async handler for Java Util Logging that also manages log backups.
-
-org.iot.dsa.node - package org.iot.dsa.node
-Persistent data model used to build the node tree of a link.
-
-org.iot.dsa.node.action - package org.iot.dsa.node.action
-org.iot.dsa.node.event - package org.iot.dsa.node.event
-org.iot.dsa.security - package org.iot.dsa.security
-org.iot.dsa.time - package org.iot.dsa.time
-org.iot.dsa.util - package org.iot.dsa.util
-OutboundInvokeHandler org.iot.dsa.dslink.requester
-Callback mechanism passed to the invoke method on DSIRequester.
-
-OutboundInvokeHandler.Mode org.iot.dsa.dslink.requester
-OutboundListHandler org.iot.dsa.dslink.requester
-Callback mechanism passed to the list method on DSIRequester.
-
-OutboundListResponse org.iot.dsa.dslink.responder
-The responder is responsible for returning this upon notification of a list request.
-
-OutboundRequestHandler org.iot.dsa.dslink.requester
-Callbacks common to all outbound requests.
-
-OutboundStream org.iot.dsa.dslink.requester
-Mechanism for the requester to close outbound requests.
-
-OutboundSubscribeHandler org.iot.dsa.dslink.requester
-Callback mechanism passed to the subscribe method in the requester.
-
-
-
-
-
-
P
-
-parse(String[]) DSLinkConfig
-Parses command line args to set the internal state of this object.
-
-PLACEHOLDER DSMetadata
-prepareParameter(DSInfo, DSMap) DSAction
-Override point, called for each parameter as it is being sent to the requester.
-
-prettyPrint AbstractWriter
-Subclasses can use this if applicable.
-
-printStackTrace() DSException
-printStackTrace(PrintStream) DSException
-printStackTrace(PrintWriter) DSException
-PrintStreamLogHandler org.iot.dsa.logging
-Async logging handler for writing to streams such as System.out.
-
-PrintStreamLogHandler(String, PrintStream) PrintStreamLogHandler
-publish(LogRecord) AsyncLogHandler
-Enqueues the record for the write thread.
-
-put(int, DSElement) DSList
-Replaces a value and returns this.
-
-put(int, boolean) DSList
-Primitive setter, returns this.
-
-put(int, double) DSList
-Primitive setter, returns this.
-
-put(int, int) DSList
-Primitive setter, returns this.
-
-put(int, long) DSList
-Primitive setter, returns this.
-
-put(int, String) DSList
-Primitive setter, returns this.
-
-put(String, DSElement) DSMap
-Adds or replaces the value for the given key and returns this.
-
-put(String, boolean) DSMap
-Primitive setter, returns this.
-
-put(String, double) DSMap
-Primitive setter, returns this.
-
-put(String, int) DSMap
-Primitive setter, returns this.
-
-put(String, long) DSMap
-Primitive setter, returns this.
-
-put(String, String) DSMap
-Primitive setter, returns this.
-
-put(String, Throwable) DSMap
-Puts a String representing the stack trace into the map.
-
-put(String, DSIObject) DSNode
-Adds or replaces the named child.
-
-put(String, boolean) DSNode
-A convenience for put(String, DSIObject)
-
-put(String, double) DSNode
-A convenience for put(String, DSIObject)
-
-put(String, float) DSNode
-A convenience for put(String, DSIObject)
-
-put(String, int) DSNode
-A convenience for put(String, DSIObject)
-
-put(String, long) DSNode
-A convenience for put(String, DSIObject)
-
-put(String, String) DSNode
-A convenience for put(String, DSIObject)
-
-put(DSInfo, DSIObject) DSNode
-Replaces the child.
-
-putAll(DSMap) DSMap
-Adds / overwrites entries in this map with those from the given.
-
-putList(String) DSMap
-Puts a new list for given key and returns it.
-
-putMap(String) DSMap
-Puts a new map for given key and returns it.
-
-putNull(String) DSMap
-Puts a null value for given key and returns this.
-
-
-
-
-
-
R
-
-readDouble(byte[], int, boolean) DSBytes
-Reads the primitive from a byte array.
-
-readDouble(InputStream, boolean) DSBytes
-Reads the primitive from a stream.
-
-readFloat(byte[], int, boolean) DSBytes
-Reads the primitive from a byte array.
-
-readFloat(InputStream, boolean) DSBytes
-Reads the primitive a stream
-
-readInt(byte[], int, boolean) DSBytes
-Reads the primitive from a byte array.
-
-readInt(InputStream, boolean) DSBytes
-Reads the primitive from a stream.
-
-readLong(byte[], int, boolean) DSBytes
-Reads the primitive from a byte array.
-
-readLong(InputStream, boolean) DSBytes
-Reads the primitive from a stream.
-
-readShort(byte[], int, boolean) DSBytes
-Reads the primitive from a byte array.
-
-readShort(InputStream, boolean) DSBytes
-Reads the primitive from a stream.
-
-recycle(Calendar) DSTime
-Return a calendar instance for reuse.
-
-registerDecoder(Class, DSIValue) DSRegistry
-DSIValues must provide an instance for decoding.
-
-REMOTE_CONFIG_FAULT DSStatus
-Bad, a configuration error is being reported by the foreign system.
-
-REMOTE_CONFIG_FAULT_STR DSStatus
-REMOTE_DISABLED DSStatus
-Bad, the foreign system is reporting the object is disabled.
-
-REMOTE_DISABLED_STR DSStatus
-REMOTE_DOWN DSStatus
-Bad, down communications are being reported by the foreign system.
-
-REMOTE_DOWN_STR DSStatus
-REMOTE_FAULT DSStatus
-Bad, an operational error is being reported by the foreign system.
-
-REMOTE_FAULT_STR DSStatus
-REMOTE_STALE DSStatus
-Bad, a stale value is being reported by the foreign system.
-
-REMOTE_STALE_STR DSStatus
-REMOTE_UNKNOWN DSStatus
-Bad, the foreign system is reporting the status is unknown.
-
-REMOTE_UNKNOWN_STR DSStatus
-remoteConfigFault DSStatus
-remoteDisabled DSStatus
-remoteDown DSStatus
-remoteFault DSStatus
-remoteStale DSStatus
-remoteUnknown DSStatus
-remove(String, OutboundRequestHandler) DSIRequester
-Submits request to remove an attribute.
-
-remove(int) DSGroup
-Removes the value at the given index and returns it.
-
-remove(int) DSList
-remove(int) DSMap
-remove(String) DSMap
-Removes the key-value pair and returns the removed value.
-
-remove(DSInfo) DSNode
-Removes the child.
-
-remove(String) DSNode
-Remove the named child if it is contained.
-
-removeFirst() DSGroup
-Remove and return the item at index 0.
-
-removeLast() DSGroup
-Remove and return the item at the highest index.
-
-removeListener(DSLinkConnection.Listener) DSLinkConnection
-Removes a listener for connection events.
-
-replace(int, int, DSList...) ActionInvocation
-Only use with open tables, deletes len rows starting at the given index, then inserts the
- given rows in their place.
-
-reset() AbstractReader
-reset() AbstractWriter
-reset() DSIReader
-Sets last() == ROOT.
-
-reset() DSIWriter
-Clears the state of the writer.
-
-reset() JsonAppender
-reset() JsonReader
-reset() JsonWriter
-reset() DSKeys.Signer
-Call to begin a new signature.
-
-reset() DSKeys.Verifier
-Call to begin a new signature.
-
-restore(DSElement) DSFlexEnum
-restore(DSElement) DSIStorable
-Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-restore(DSElement) DSJavaEnum
-restore(DSElement) DSStatus
-restore(File) DSKeys
-Decodes a key pair that was encoded by the store method.
-
-restore(InputStream) DSKeys
-Decodes a key pair that was encoded by the store method, does not onClose the given stream.
-
-restore(DSElement) DSPasswordAes
-restore(DSElement) DSPasswordSha256
-run() DSLink
-Calls starts, waits the stableDelay, then calls stable.
-
-run(Runnable) DSRuntime
-Run as soon as possible on the application's thread pool and run only once.
-
-run(Runnable, long, long) DSRuntime
-Run periodically starting at the given time and repeat at the given millisecond interval.
-
-run() DSRuntime.Timer
-Do not call.
-
-runAt(Runnable, long) DSRuntime
-Run once at the given time.
-
-runCount() DSRuntime.Timer
-The number of completed runs.
-
-runDelayed(Runnable, long) DSRuntime
-Run once after the given delay.
-
-
-
-
-
-
S
-
-save() DSLink
-Serializes the configuration database.
-
-send(DSList) ActionInvocation
-Only use with stream and open tables.
-
-set(String, DSIValue, OutboundRequestHandler) DSIRequester
-Submits a set request.
-
-set(String, DSElement) DSMetadata
-Set arbitrary keys.
-
-setAdmin(boolean) DSInfo
-setAutoClose(boolean) SimpleInvokeHandler
-Whether or not to auto close the stream on the first update.
-
-setBackupThreshold(int) FileLogHandler
-The file size threshold after which a logging file will be backed up and cleared.
-
-setBeginList() AbstractReader
-setBeginMap() AbstractReader
-setBit(int, int, boolean) DSUtil
-Set or unset a bit at the given index.
-
-setBooleanRange(DSList) DSMetadata
-The list must be size 2 and the entries must not be null.
-
-setBooleanRange(String, String) DSMetadata
-The parameters can be null, which will result in the default text (false/true).
-
-setBrokerUri(String) DSLinkConfig
-setConfig(String, boolean) DSLinkConfig
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-setConfig(String, double) DSLinkConfig
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-setConfig(String, int) DSLinkConfig
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-setConfig(String, long) DSLinkConfig
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-setConfig(String, String) DSLinkConfig
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-setDecimalPlaces(DSLong) DSMetadata
-setDefault(DSIValue) DSMetadata
-Sets the default value only, does not set type information.
-
-setDefaultLevel(Level) DSLogging
-setDescription(String) DSMetadata
-setDetail(String) DSRequestException
-Overrides the default detail which is the stack trace of this exception.
-
-setDetail(Throwable) DSRequestException
-Overrides the default detail which is the stack trace of this exception.
-
-setDisplayName(String) DSMetadata
-setDslinkJson(DSMap) DSLinkConfig
-Directly set the map without using file io.
-
-setDslinkJson(File) DSLinkConfig
-Sets the link map by file path.
-
-setEditor(String) DSMetadata
-See the EDITOR_ constants.
-
-setEndInput() AbstractReader
-setEndList() AbstractReader
-setEndMap() AbstractReader
-setEnumRange(DSList) DSMetadata
-List of string values for an enum or string.
-
-setEnumRange(String...) DSMetadata
-List of string values for an enum or string.
-
-setHidden(boolean) DSInfo
-setInput(CharSequence) JsonReader
-Sets the input source, resets to ROOT, and returns this.
-
-setInput(File) JsonReader
-Sets the input source, resets to ROOT, and returns this.
-
-setInput(InputStream, String) JsonReader
-Sets the input source, resets to ROOT, and returns this.
-
-setInput(Reader) JsonReader
-Sets the input source, resets to ROOT, and returns this.
-
-setKeys(DSKeys) DSLinkConfig
-Directly set the keys without using file io.
-
-setKeys(File) DSLinkConfig
-Sets the link keys by file path.
-
-setLinkName(String) DSLinkConfig
-Overrides dslink.json.
-
-setLogLevel(String) DSLinkConfig
-Should be one of the following (case insensitive): all, finest, finer, fine, config, info,
- warning, severe, off.
-
-setLogLevel(Level) DSLinkConfig
-Overrides dslink.json.
-
-setMainType(Class) DSLinkConfig
-The type of the root node.
-
-setMap(DSMap) DSMetadata
-Change the underlying map so the metadata instance can be reused.
-
-setMaxBackups(int) FileLogHandler
-The default is 10.
-
-setMaxQueueSize(int) AsyncLogHandler
-setMaxValue(DSElement) DSMetadata
-The arg should be a number.
-
-setMinValue(DSElement) DSMetadata
-The arg should be a number.
-
-setName(String) DSMetadata
-setNextValue(boolean) AbstractReader
-setNextValue(byte[]) AbstractReader
-setNextValue(double) AbstractReader
-setNextValue(long) AbstractReader
-setNextValue(String) AbstractReader
-setNextValueNull() AbstractReader
-setNodes(DSMainNode) DSLink
-setNodesFile(File) DSLinkConfig
-Overrides dslink.json.
-
-setOut(PrintStream) AsyncLogHandler
-Sets the sink for formatted messages.
-
-setOutput(Appendable) JsonAppender
-Sets the sink, resets the state and returns this.
-
-setOutput(File) JsonAppender
-Sets the sink, resets the state and returns this.
-
-setOutput(File, String) JsonAppender
-Will create a zip file using the zipFileName as file name inside the zip.
-
-setOutput(OutputStream) JsonAppender
-Sets the sink, resets the state and returns this.
-
-setOutput(OutputStream, String) JsonAppender
-Will write a zip file to the given stream.
-
-setOutput(File) JsonWriter
-Sets the sink, resets the state and returns this.
-
-setOutput(File, String) JsonWriter
-Will create a zip file using the zipFileName as file name inside the zip.
-
-setOutput(OutputStream) JsonWriter
-Sets the sink, resets the state and returns this.
-
-setOutput(OutputStream, String) JsonWriter
-Will write a zip file to the given stream.
-
-setOutput(Writer) JsonWriter
-Sets the sink, resets the state and returns this.
-
-setPlaceHolder(String) DSMetadata
-Place holder text for text fields.
-
-setPrettyPrint(boolean) AbstractJsonWriter
-setReadOnly(boolean) DSInfo
-setResultType(ActionSpec.ResultType) DSAction
-Returns this, it is not necessary to set the result to void.
-
-setSaveEnabled(boolean) DSLink
-This is a transient option intended for unit tests.
-
-setSkipMissedIntervals(boolean) DSRuntime.Timer
-The default is true, set this to false if all intervals should be run, even if they run
- later than scheduled.
-
-setToken(String) DSLinkConfig
-Overrides dslink.json.
-
-setTransient(boolean) DSInfo
-setType(DSIValue) DSMetadata
-Sets the type and if the given is an enum, sets the enum range as well.
-
-setType(DSValueType) DSMetadata
-The type for action parameters, can be used to override types in the responder api.
-
-setUnit(String) DSMetadata
-The unit identifier.
-
-shutdown() DSLink
-Properly shuts down the link when a thread is executing the run method.
-
-sign(byte[], int, int) DSKeys
-A convenience that creates a signer and signs the given bytes.
-
-Signer(PrivateKey) DSKeys.Signer
-SimpleInvokeHandler org.iot.dsa.dslink.requester
-Action handler for non-tables/streams.
-
-SimpleInvokeHandler() SimpleInvokeHandler
-SimpleRequestHandler org.iot.dsa.dslink.requester
-Empty callback implementations.
-
-SimpleRequestHandler() SimpleRequestHandler
-size() DSGroup
-The number of items is the group.
-
-size() DSList
-size() DSMap
-splitPath(String) DSPath
-Splits the path, but does not decode any names.
-
-stable() DSNode
-Called after the entire subtree is started.
-
-STALE DSStatus
-Bad, the value hasn't updated in a reasonable amount of time (user configurable on a per
- point basis) within DSA.
-
-stale DSStatus
-STALE_STR DSStatus
-start() AsyncLogHandler
-This must be called for the handler to actually do anything.
-
-start() DSNode
-Sets the state to starting.
-
-stop() DSNode
-Sets the state to stopped.
-
-store() DSFlexEnum
-store() DSIStorable
-Serialize the value for the configuration database.
-
-store() DSJavaEnum
-store() DSStatus
-store(File) DSKeys
-Write the bytes from the string encoding to the given file.
-
-store(OutputStream) DSKeys
-Writes the bytes from the string encoding to the given stream, does not onClose the stream.
-
-store() DSPasswordAes
-store() DSPasswordSha256
-subscribe(String, int, OutboundSubscribeHandler) DSIRequester
-Submits a subscribe request.
-
-subscribe(DSTopic, DSInfo, DSISubscriber) DSNode
-Subscribes the child and topic.
-
-SubscriptionCloseHandler org.iot.dsa.dslink.responder
-The responder returns this from the subscription request notification method so the link can
- notify the responder whenever a subscription is terminated.
-
-
-
-
-
-
T
-
-throwRuntime(Throwable) DSException
-If the given exception is already a runtime exception, it is rethrown, otherwise
- it will be thrown wrapped by an instance of this class.
-
-timeInMillis() DSDateTime
-The Java time represented by this object.
-
-toBoolean() DSBool
-toBoolean() DSDouble
-toBoolean() DSElement
-Attempts to return a boolean value.
-
-toBoolean() DSIBoolean
-toBoolean() DSLong
-toBoolean() DSString
-toBytes() DSBytes
-toBytes() DSElement
-Returns the raw byte array for DSBytes only, which should not be modified.
-
-toDouble() DSBool
-0 or 1.
-
-toDouble() DSDouble
-toDouble() DSElement
-Attempts to return a double value.
-
-toDouble() DSFloat
-toDouble() DSInt
-toDouble() DSINumber
-If not a double, will cast the underlying value.
-
-toDouble() DSLong
-toElement() DSElement
-Returns this.
-
-toElement() DSFlexEnum
-toElement() DSFloat
-toElement() DSInt
-toElement() DSIValue
-The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-toElement() DSJavaEnum
-toElement() DSList
-toElement() DSMap
-toElement() DSNull
-Returns this.
-
-toElement() DSStatus
-toElement() DSValueNode
-toElement() DSPasswordAes
-Returns a string representing the url safe base64 encoding of the hash.
-
-toElement() DSPasswordSha256
-Returns a string representing the url safe base64 encoding of the hash.
-
-toElement() DSDateTime
-toEnum() DSJavaEnum
-The Java enum.
-
-toFloat() DSBool
-0 or 1.
-
-toFloat() DSDouble
-toFloat() DSElement
-Attempts to return a float value.
-
-toFloat() DSFloat
-toFloat() DSInt
-toFloat() DSINumber
-If not a float, will cast the underlying value.
-
-toFloat() DSLong
-toGroup() DSElement
-Lists and maps return themselves, everything else results in an exception.
-
-toGroup() DSGroup
-toHex(byte, StringBuilder) DSBytes
-Converts the bytes into a hex string.
-
-toHex(byte[], StringBuilder) DSBytes
-Converts the bytes into a hex string.
-
-toInt() DSBool
-0 or 1.
-
-toInt() DSDouble
-toInt() DSElement
-Attempts to return an int value.
-
-toInt() DSFloat
-toInt() DSInt
-toInt() DSINumber
-If not an int, will cast the underlying value.
-
-toInt() DSLong
-toList() DSElement
-Lists return themselves, everything else results in an exception.
-
-toList() DSList
-toLong() DSBool
-0 or 1.
-
-toLong() DSDouble
-toLong() DSElement
-Attempts to return a long value.
-
-toLong() DSFloat
-toLong() DSInt
-toLong() DSINumber
-If not a long, will cast the underlying value.
-
-toLong() DSLong
-toMap() DSElement
-Maps return themselves, everything else results in an exception.
-
-toMap() DSMap
-toNode(Object) DSNode
-A convenience that casts the argument to a node.
-
-toNumber() DSDouble
-toNumber() DSFloat
-toNumber() DSInt
-toNumber() DSINumber
-Returns the Java primitive wrapper.
-
-toNumber() DSLong
-toStatus() DSIStatus
-toStatus() DSStatus
-toString() DSRuntime.Timer
-toString() ActionSpec.ResultType
-toString() DSBool
-toString() DSBytes
-toString() DSDouble
-toString() DSElementType
-toString() DSFlexEnum
-toString() DSFloat
-toString() DSGroup
-Json encodes the graph, be careful.
-
-toString() DSIEnum
-The string representation of the the enum value.
-
-toString() DSInt
-toString() DSJavaEnum
-toString() DSLong
-toString() DSNull
-toString() DSStatus
-toString() DSString
-toString() DSValue
-If isNull(), returns "null", otherwise returns toElement().toString()
-
-toString() DSValueType
-toString() DSPasswordAes
-toString() DSPasswordSha256
-toString() DSPermission
-toString() DSDateTime
-ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
-
-toString() DSException
-TRACE DSILevels
-trace DSILevels
-trace() DSLogger
-True if the level is loggable.
-
-trace(Object) DSLogger
-Log a trace or verbose event.
-
-trace(Object, Throwable) DSLogger
-Log a trace or verbose event.
-
-trimBackups() FileLogHandler
-Only public for testing, do not call.
-
-TRUE DSBool
-TYPE DSMetadata
-
-
-
-
-
U
-
-UNIT DSMetadata
-UNKNOWN DSStatus
-Bad, the status is unknown within DSA, typically the initial state at boot.
-
-unknown DSStatus
-UNKNOWN_STR DSStatus
-unsubscribe(DSTopic, DSInfo, DSISubscriber) DSNode
-Unsubscribes the tuple.
-
-update(long, DSIValue, DSStatus) InboundSubscribeRequest
-The responder should call this when first received and then whenever the value or status
- changes.
-
-update(byte[]) DSKeys.Signer
-Update the signature with the given bytes.
-
-update(byte[], int, int) DSKeys.Signer
-Update the signature with the given bytes.
-
-update(byte[]) DSKeys.Verifier
-Update the signature with the given bytes.
-
-update(byte[], int, int) DSKeys.Verifier
-Update the signature with the given bytes.
-
-UTF8 DSString
-The standard UTF8 charset, can be used with string.getBytes(Charset).
-
-
-
-
-
-
V
-
-valBoolean AbstractReader
-valBytes AbstractReader
-validate(byte[]) DSKeys.Verifier
-Returns true if the given signature is valid for the bytes passed to update.
-
-validate(String) DSKeys.Verifier
-Returns true if the given base 64 encoded signature is valid for the bytes passed to
- update.
-
-validateChild(DSIObject) DSNode
-Override point, throw a meaningful IllegalArgumentException if the child is not allowed
-
-validateParent(DSNode) DSMainNode
-The parent must be a DSLink instance.
-
-validateParent(DSNode) DSSysNode
-validateParent(DSNode) DSNode
-Override point, throw a meaningful IllegalArgumentException if the parent is not allowed
-
-valLong AbstractReader
-valReal AbstractReader
-valString AbstractReader
-value(DSElement) AbstractWriter
-value(boolean) AbstractWriter
-value(byte[]) AbstractWriter
-value(double) AbstractWriter
-value(int) AbstractWriter
-value(long) AbstractWriter
-value(String) AbstractWriter
-value(DSElement) DSIWriter
-Write a value to the map or list.
-
-value(boolean) DSIWriter
-Write a value to the map or list.
-
-value(byte[]) DSIWriter
-Write a value to the map or list.
-
-value(double) DSIWriter
-Write a value to the map or list.
-
-value(int) DSIWriter
-Write a value to the map or list.
-
-value(long) DSIWriter
-Write a value to the map or list.
-
-value(String) DSIWriter
-Write a value to the map or list.
-
-value(DSElement) AbstractJsonWriter
-VALUE_TOPIC DSNode
-valueOf(String) ErrorType
-Returns the enum constant of this type with the specified name.
-
-valueOf(String) OutboundInvokeHandler.Mode
-Returns the enum constant of this type with the specified name.
-
-valueOf(String) DSIReader.Token
-Returns the enum constant of this type with the specified name.
-
-valueOf(String) ActionSpec.ResultType
-Returns the enum constant of this type with the specified name.
-
-valueOf(boolean) DSBool
-Will return either TRUE or FALSE.
-
-valueOf(DSElement) DSBool
-valueOf(String) DSBool
-Will return NULL, TRUE or FALSE.
-
-valueOf(byte[]) DSBytes
-valueOf(DSElement) DSBytes
-valueOf(String) DSBytes
-Decodes a base64 encoded byte array.
-
-valueOf(double) DSDouble
-Attempts to reuse some common values before creating a new instance.
-
-valueOf(DSElement) DSDouble
-valueOf(String) DSDouble
-Checks for null, then uses Double.parseDouble()
-
-valueOf(DSElement) DSElement
-Returns the argument.
-
-valueOf(String) DSElementType
-Returns the enum constant of this type with the specified name.
-
-valueOf(DSElement) DSFlexEnum
-valueOf(String, DSList) DSFlexEnum
-Creates a enum representing the given value and range.
-
-valueOf(String) DSFlexEnum
-Creates a new enum for the given value using the range from this instance.
-
-valueOf(DSElement) DSFloat
-valueOf(float) DSFloat
-Attempts to reuse some common values before creating a new instance.
-
-valueOf(String) DSFloat
-Checks for null, then uses Float.parseFloat()
-
-valueOf(DSElement) DSInt
-valueOf(int) DSInt
-Attempts to reuse some common values before creating a new instance.
-
-valueOf(String) DSInt
-Checks for null, then uses Float.parseFloat()
-
-valueOf(DSElement) DSIValue
-This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-valueOf(DSElement) DSJavaEnum
-valueOf(Enum) DSJavaEnum
-Creates an enum for the given value (and it's range).
-
-valueOf(String) DSJavaEnum
-valueOf(DSElement) DSList
-valueOf(DSElement...) DSList
-valueOf(Double...) DSList
-valueOf(Long...) DSList
-valueOf(String...) DSList
-valueOf(DSElement) DSLong
-Returns this.
-
-valueOf(long) DSLong
-Attempts to reuse some common values before creating a new instance.
-
-valueOf(String) DSLong
-Checks for null, then uses Float.parseFloat()
-
-valueOf(DSElement) DSMap
-valueOf(DSElement) DSNull
-Returns this.
-
-valueOf(DSElement) DSStatus
-valueOf(String) DSStatus
-valueOf(DSElement) DSString
-valueOf(Object) DSString
-valueOf(DSElement) DSValueNode
-valueOf(String) DSValueType
-Returns the enum constant of this type with the specified name.
-
-valueOf(String) DSInfoTopic.Event
-Returns the enum constant of this type with the specified name.
-
-valueOf(String) DSValueTopic.Event
-Returns the enum constant of this type with the specified name.
-
-valueOf(DSElement) DSPasswordAes
-Creates a encrypted password for the given clear text.
-
-valueOf(String) DSPasswordAes
-Creates a encrypted password for the given clear text.
-
-valueOf(DSElement) DSPasswordSha256
-Creates a digest password for the given clear text.
-
-valueOf(String) DSPasswordSha256
-Creates a digest password for the given clear text.
-
-valueOf(String) DSPermission
-Returns the enum constant of this type with the specified name.
-
-valueOf(int) DSPermission
-valueOf(DSElement) DSDateTime
-valueOf(long) DSDateTime
-valueOf(String) DSDateTime
-Decodes an ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
-
-valueOf(String) DSInterval
-Returns the enum constant of this type with the specified name.
-
-values() ErrorType
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() OutboundInvokeHandler.Mode
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() DSIReader.Token
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() ActionSpec.ResultType
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() DSElementType
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() DSValueType
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() DSInfoTopic.Event
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() DSValueTopic.Event
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() DSPermission
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-values() DSInterval
-Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-Verifier(PublicKey) DSKeys.Verifier
-verify(byte[], int, int, String) DSKeys
-A convenience that creates a verifier and validates the signature for the given bytes.
-
-
-
-
-
-
W
-
-WARN DSILevels
-warn DSILevels
-warn() DSLogger
-True if the level is loggable.
-
-warn(Object) DSLogger
-Log an unusual but not critical event.
-
-warn(Object, Throwable) DSLogger
-Log an unusual but not critical event.
-
-wasHelpRequested() DSLinkConfig
-Whether or not -h or --help was provided.
-
-write(boolean) AbstractWriter
-Write the value.
-
-write(byte[]) AbstractWriter
-Write the value.
-
-write(double) AbstractWriter
-Write the value.
-
-write(long) AbstractWriter
-Write the value.
-
-write(boolean) AbstractJsonWriter
-write(byte[]) AbstractJsonWriter
-write(double) AbstractJsonWriter
-write(long) AbstractJsonWriter
-write(LogRecord) AsyncLogHandler
-Formats and writes the logging record the underlying stream.
-
-writeDouble(double, byte[], int, boolean) DSBytes
-Encodes the primitive into a byte array.
-
-writeDouble(double, OutputStream, boolean) DSBytes
-Encodes the primitive into a stream.
-
-writeFloat(float, byte[], int, boolean) DSBytes
-Encodes the primitive into a byte array.
-
-writeFloat(float, OutputStream, boolean) DSBytes
-Encodes the primitive into a stream
-
-writeInt(int, byte[], int, boolean) DSBytes
-Encodes the primitive into a byte array.
-
-writeInt(int, OutputStream, boolean) DSBytes
-Encodes the primitive into a stream.
-
-writeKey(CharSequence) AbstractWriter
-Write string key of a map entry.
-
-writeKey(CharSequence) AbstractJsonWriter
-writeKeyValueSeparator() AbstractWriter
-Separate the key from the value in a map.
-
-writeKeyValueSeparator() AbstractJsonWriter
-writeListEnd() AbstractWriter
-End the current list.
-
-writeListEnd() AbstractJsonWriter
-writeListStart(int) AbstractWriter
-Start a new list.
-
-writeListStart(int) AbstractJsonWriter
-writeLong(long, byte[], int, boolean) DSBytes
-Encodes the primitive into a byte array.
-
-writeLong(long, OutputStream, boolean) DSBytes
-Encodes the primitive into a stream.
-
-writeMapEnd() AbstractWriter
-End the current map.
-
-writeMapEnd() AbstractJsonWriter
-writeMapStart(int) AbstractWriter
-Start a new map.
-
-writeMapStart(int) AbstractJsonWriter
-writeNewLineIndent() AbstractWriter
-Override point for subclasses which perform use pretty printing, such as json.
-
-writeNewLineIndent() AbstractJsonWriter
-Two spaces per level.
-
-writeNull() AbstractWriter
-Write a null value.
-
-writeNull() AbstractJsonWriter
-writeSeparator() AbstractWriter
-Write a value separator, such as the comma in json.
-
-writeSeparator() AbstractJsonWriter
-writeShort(short, byte[], int, boolean) DSBytes
-Encodes the primitive into a byte array.
-
-writeShort(short, OutputStream, boolean) DSBytes
-Encodes the primitive into a stream.
-
-writeValue(CharSequence) AbstractWriter
-Write the value, which will never be null.
-
-writeValue(CharSequence) AbstractJsonWriter
-
-
A B C D E F G H I J K L M N O P R S T U V W dslink-core 0.19.0 API
-=======
-
-dslink-core 0.20.0 API
->>>>>>> 22064982f1faddb35f2da7c8a183dbbc8602cbe9
-
-
-
-
-
-<![CDATA[
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
-<h2>Frame Alert</h2>
-<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p>
-]]>
-
-
diff --git a/docs/javadoc/org/iot/dsa/DSRuntime.Timer.html b/docs/javadoc/org/iot/dsa/DSRuntime.Timer.html
deleted file mode 100644
index 3a42047e..00000000
--- a/docs/javadoc/org/iot/dsa/DSRuntime.Timer.html
+++ /dev/null
@@ -1,450 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-DSRuntime.Timer (dslink-core 0.19.0 API)
-DSRuntime.Timer (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.DSRuntime.Timer
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-voidcancel Cancel execution, will not impact current running tasks and will have no effect if
- already cancelled.
-
-
-longgetInterval The interval between runs, zero or less for no interval.
-
-
-java.lang.RunnablegetRunnable The runnable being managed by this timer.
-
-
-booleanisCancelled
-
-booleanisFinished True if cancelled or was a one time execution and that has finished.
-
-
-booleanisRunning True when the runnable is being actually being executed.
-
-
-longlastRun The lastRun run or -1 if it hasn't run yet.
-
-
-longnextRun The next scheduled time to run.
-
-
-voidrun Do not call.
-
-
-longrunCount The number of completed runs.
-
-
-DSRuntime.Timer setSkipMissedIntervals The default is true, set this to false if all intervals should be run, even if they run
- later than scheduled.
-
-
-java.lang.StringtoString
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-run
-public void run()
-Do not call.
-
-Specified by: run in interface java.lang.Runnable
-
-
-
-
-
-
-
-
-
-
-
-setSkipMissedIntervals
-public DSRuntime.Timer setSkipMissedIntervals(boolean skipMissed)
-The default is true, set this to false if all intervals should be run, even if they run
- later than scheduled.
-
-Parameters: skipMissed - False if intervals should be run after they were scheduled to.Returns: this
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSRuntime (dslink-core 0.19.0 API)
-DSRuntime (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Class and Description
-
-
-static class DSRuntime.Timer Can be used to inspect and cancel tasks passed to the run methods in DSRuntime.
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static voidrun Run as soon as possible on the application's thread pool and run only once.
-
-
-static DSRuntime.Timer run Run periodically starting at the given time and repeat at the given millisecond interval.
-
-
-static DSRuntime.Timer runAt Run once at the given time.
-
-
-static DSRuntime.Timer runDelayed Run once after the given delay.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-run
-public static DSRuntime.Timer run(java.lang.Runnable arg,
- long start,
- long interval)
-Run periodically starting at the given time and repeat at the given millisecond interval.
-
-Parameters: arg - What to runAt.start - First absolute execution time, or if less or equal to 0, start immediately.interval - The millisecond interval at which to run.Returns: For inspecting and cancel execution.
-
-
-
-
-
-
-
-
-
-
-
-
-runDelayed
-public static DSRuntime.Timer runDelayed(java.lang.Runnable arg,
- long delayMillis)
-Run once after the given delay.
-
-Parameters: arg - What to runAt.delayMillis - The number of millis to wait before running.Returns: For inspecting and cancel execution.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIRequester (dslink-core 0.19.0 API)
-DSIRequester (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIResponder (dslink-core 0.19.0 API)
-DSIResponder (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-public interface DSIResponder
-Interface for nodes in the node tree to manually handle requests. The first implementation
- encountered in the path of a request will be given the responsibility for processing the
- request.
-
- For error handling, simply throw an exception from any of these methods to have the error
- reported to the requester and the stream closed. There are a few predefined exceptions to be
- aware of listed below. Non DSRequestExceptions will be reported as server errors.
-
-See Also: DSInvalidPathExceptionDSPermissionExceptionDSRequestException
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-onInvoke
-ActionResult onInvoke(InboundInvokeRequest request)The implementation should quickly create an object for responding to the request, but do no
- processing of it on the calling thread. Simply throw a descriptive exception to report an
- error with the request.
-
-Parameters: request - The details of the request and the mechanism for providing updates.Returns: The initial response and close notification mechanism, can be null if the if the
- result type is void.
-
-
-
-
-
-
-
-
-onList
-OutboundListResponse onList(InboundListRequest request)The implementation should quickly create an object for responding to the request, but do no
- processing of it on the calling thread. Simply throw a descriptive exception to report an
- error with the request.
-
-Parameters: request - The details of the request and the mechanism for providing updates.Returns: The initial response and close mechanism.
-
-
-
-
-
-
-
-
-onSubscribe
-SubscriptionCloseHandler onSubscribe(InboundSubscribeRequest request)The implementation should quickly create an object for responding to the request, but do no
- processing of it on the calling thread. Simply throw a descriptive exception to report an
- error with the request.
-
-Parameters: request - The details of the request and the mechanism for sending updates.Returns: Who to notify when the subscription is closed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSInternalErrorException (dslink-core 0.19.0 API)
-DSInternalErrorException (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-org.iot.dsa.dslink.DSInternalErrorException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
- DSInvalidPathException (dslink-core 0.19.0 API)
-DSInvalidPathException (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
- DSLink (dslink-core 0.19.0 API)
-DSLink (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSLink Use the load method to create links.
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-protected voiddeclareDefaults Adds the save action, overrides should call super if they want this action.
-
-
-DSLinkConfig getConfig
-
-DSLinkConnection getConnection
-
-java.lang.StringgetDsId Returns the unique id of the connection.
-
-
-DSKeys getKeys Public / private keys of the link, used to prove identity with brokers.
-
-
-java.lang.StringgetLinkName As defined in dslink.json.
-
-
-protected java.lang.StringgetLogName Override point, returns the simple class name by default.
-
-
-DSMainNode getMain
-
-DSSysNode getSys
-
-protected DSLink init DSLinkConfig config)Configures a link instance including creating the appropriate connection.
-
-
-static DSLink load DSLinkConfig config)Creates a link by first testing for an existing serialized database.
-
-
-static voidmain This is a convenience for DSLink.load(new DSLinkConfig(args)).run() and can be used as the
- the main class for any link.
-
-
-protected voidonStopped Called once this node and its entire subtree is stopped.
-
-
-voidrun Calls starts, waits the stableDelay, then calls stable.
-
-
-voidsave Serializes the configuration database.
-
-
-DSLink setNodes DSMainNode node)
-
-protected DSLink setSaveEnabled This is a transient option intended for unit tests.
-
-
-voidshutdown Properly shuts down the link when a thread is executing the run method.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSNode
-add , childCount , clear , contains , copy , declareDefault , fire , fire , get , getElement , getFirst , getFirstInfo , getFirstNodeInfo , getInfo , getInfo , getLast , getLastInfo , getMetadata , getName , getNode , getParent , getPath , getValue , isDefaultInstance , isEqual , isIdentical , isNode , isNull , isRunning , isStable , isStarted , isStopped , isSubscribed , isSubscribed , isSubscribed , iterateNodes , iterateValues , iterator , onChildAdded , onChildChanged , onChildRemoved , onInfoChanged , onInvoke , onSet , onSet , onStable , onStarted , onSubscribe , onSubscribed , onSubscribed , onUnsubscribe , onUnsubscribed , onUnsubscribed , put , put , put , put , put , put , put , put , remove , remove , stable , start , stop , subscribe , toNode , unsubscribe , validateChild , validateParent
-
-
-
-
-Methods inherited from class org.iot.dsa.logging.DSLogger
-admin , admin , admin , debug , debug , debug , error , error , error , fatal , fatal , fatal , fine , fine , fine , info , info , info , trace , trace , trace , warn , warn , warn
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.lang.Iterable
-forEach, spliterator
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-main
-public static void main(java.lang.String[] args)
-This is a convenience for DSLink.load(new DSLinkConfig(args)).run() and can be used as the
- the main class for any link. Use DSLink.shutdown() to stop running.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSLinkConfig (dslink-core 0.19.0 API)
-DSLinkConfig (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.dslink.DSLinkConfig
-
-
-
-
-
-
-
-All Implemented Interfaces:
-DSILevels
-public class DSLinkConfig
-extends java.lang.Object
-implements DSILevels
-Configuration options for starting a link. The base configuration is the file dslink.json.
- Command line options can override the values in that file. More common options have getters and
- setters as a convenience.
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSLinkConfig This will create an empty unvalidated getConfig.
-
-
-DSLinkConfig Can be use to change the working dir from the default process working dir.
-
-
-DSLinkConfig Constructor for simulating a command line invocation, the argument will be split on the space
- character.
-
-
-DSLinkConfig Constructor for the arguments pass to a main method.
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.StringgetBrokerUri If not set, will look for the getConfig in dslink.json.
-
-
-booleangetConfig Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-doublegetConfig Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-intgetConfig Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-longgetConfig Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-java.lang.StringgetConfig Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-java.lang.StringgetDsaVersion
-
-DSMap getDslinkJson If not set, this will attempt to open dslink.json in the working the process directory.
-
-
-static java.lang.StringgetHelpText Help text for command line options.
-
-
-DSKeys getKeys If not set, will attempt to use the getConfig in dslink.json and fall back to '.key' in the
- process directory if necessary.
-
-
-java.lang.StringgetLinkName
-
-java.util.logging.LevelgetLogLevel If not set, will attempt to use the getConfig in dslink.json but fall back to 'info' if
- necessary.
-
-
-java.lang.StringgetMainType The type of the root node.
-
-
-java.io.FilegetNodesFile If not set, will attempt to use the getConfig in dslink.json but fall back to 'nodes.zip' in
- the process directory if necessary.
-
-
-java.lang.StringgetToken Authentication token for the broker, this can return null.
-
-
-protected voidparse Parses command line args to set the internal state of this object.
-
-
-DSLinkConfig setBrokerUri
-
-DSLinkConfig setConfig Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-DSLinkConfig setConfig Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-DSLinkConfig setConfig Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-DSLinkConfig setConfig Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-DSLinkConfig setConfig Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-DSLinkConfig setDslinkJson DSMap map)Directly set the map without using file io.
-
-
-DSLinkConfig setDslinkJson Sets the link map by file path.
-
-
-DSLinkConfig setKeys DSKeys keys)Directly set the keys without using file io.
-
-
-DSLinkConfig setKeys Sets the link keys by file path.
-
-
-DSLinkConfig setLinkName Overrides dslink.json.
-
-
-DSLinkConfig setLogLevel Overrides dslink.json.
-
-
-DSLinkConfig setLogLevel Should be one of the following (case insensitive): all, finest, finer, fine, config, info,
- warning, severe, off.
-
-
-DSLinkConfig setMainType The type of the root node.
-
-
-DSLinkConfig setNodesFile Overrides dslink.json.
-
-
-DSLinkConfig setToken Overrides dslink.json.
-
-
-booleanwasHelpRequested Whether or not -h or --help was provided.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-DSLinkConfig
-public DSLinkConfig(java.lang.String args)
-Constructor for simulating a command line invocation, the argument will be split on the space
- character.
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getBrokerUri
-public java.lang.String getBrokerUri()
-If not set, will look for the getConfig in dslink.json. This is a required getConfig so
- it'll be validated as long as the public no-arg constructor is avoided.
-
-
-
-
-
-
-
-getConfig
-public boolean getConfig(java.lang.String name,
- boolean fallback)
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-
-
-
-
-
-getConfig
-public double getConfig(java.lang.String name,
- double fallback)
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-
-
-
-
-
-getConfig
-public int getConfig(java.lang.String name,
- int fallback)
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-
-
-
-
-
-getConfig
-public long getConfig(java.lang.String name,
- long fallback)
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-
-
-
-
-
-getConfig
-public java.lang.String getConfig(java.lang.String name,
- java.lang.String fallback)
-Looks for the value in dslink.json and if not found, returns the fallback.
-
-
-
-
-
-
-
-
-
-
-
-getDslinkJson
-public DSMap getDslinkJson()
-If not set, this will attempt to open dslink.json in the working the process directory.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getLogLevel
-public java.util.logging.Level getLogLevel()
-If not set, will attempt to use the getConfig in dslink.json but fall back to 'info' if
- necessary.
-
-
-
-
-
-
-
-getNodesFile
-public java.io.File getNodesFile()
-If not set, will attempt to use the getConfig in dslink.json but fall back to 'nodes.zip' in
- the process directory if necessary.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-setConfig
-public DSLinkConfig setConfig(java.lang.String name,
- boolean value)
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-
-
-
-
-
-setConfig
-public DSLinkConfig setConfig(java.lang.String name,
- double value)
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-
-
-
-
-
-setConfig
-public DSLinkConfig setConfig(java.lang.String name,
- int value)
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-
-
-
-
-
-setConfig
-public DSLinkConfig setConfig(java.lang.String name,
- long value)
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-
-
-
-
-
-setConfig
-public DSLinkConfig setConfig(java.lang.String name,
- java.lang.String value)
-Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSLinkConnection.Listener (dslink-core 0.19.0 API)
-DSLinkConnection.Listener (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSLinkConnection (dslink-core 0.19.0 API)
-DSLinkConnection (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Class and Description
-
-
-static interface DSLinkConnection.Listener Intended for requester functionality so that requesters can know when to
- start and stop making requests.
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSNode
-add , childCount , clear , contains , copy , declareDefault , declareDefaults , fire , fire , get , getElement , getFirst , getFirstInfo , getFirstNodeInfo , getInfo , getInfo , getLast , getLastInfo , getMetadata , getName , getNode , getParent , getPath , getValue , isDefaultInstance , isEqual , isIdentical , isNode , isNull , isRunning , isStable , isStarted , isStopped , isSubscribed , isSubscribed , isSubscribed , iterateNodes , iterateValues , iterator , onChildAdded , onChildChanged , onChildRemoved , onInfoChanged , onInvoke , onSet , onSet , onStarted , onStopped , onSubscribe , onSubscribed , onSubscribed , onUnsubscribe , onUnsubscribed , onUnsubscribed , put , put , put , put , put , put , put , put , remove , remove , stable , start , stop , subscribe , toNode , unsubscribe , validateChild , validateParent
-
-
-
-
-Methods inherited from class org.iot.dsa.logging.DSLogger
-admin , admin , admin , debug , debug , debug , error , error , error , fatal , fatal , fatal , fine , fine , fine , info , info , info , trace , trace , trace , warn , warn , warn
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.lang.Iterable
-forEach, spliterator
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-addListener
-public void addListener(DSLinkConnection.Listener listener)
-Adds a listener for connection events. If already connected, onConnect
- will be called on the listener.
-
-
-
-
-
-
-
-disconnect
-public abstract void disconnect()
-Forcefully closes an open connection. Does not prevent reconnection, intended for
- dealing with problems.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-onConnect
-protected abstract void onConnect()
-Called after onInitialize and before onRun. This should open the connection,
- maybe do some preamble messaging, but should return relatively quickly. Use
- onRun for the long running of the connection.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-onRun
-protected abstract void onRun()
-The long term management of the connection (reading and writing). When this
- returns, onDisconnect will be called.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSMainNode (dslink-core 0.19.0 API)
-DSMainNode (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSMainNode
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSNode
-add , childCount , clear , contains , copy , declareDefault , declareDefaults , fire , fire , get , getElement , getFirst , getFirstInfo , getFirstNodeInfo , getInfo , getInfo , getLast , getLastInfo , getMetadata , getName , getNode , getParent , getPath , getValue , isDefaultInstance , isEqual , isIdentical , isNode , isNull , isRunning , isStable , isStarted , isStopped , isSubscribed , isSubscribed , isSubscribed , iterateNodes , iterateValues , iterator , onChildAdded , onChildChanged , onChildRemoved , onInfoChanged , onInvoke , onSet , onSet , onStable , onStarted , onStopped , onSubscribe , onSubscribed , onSubscribed , onUnsubscribe , onUnsubscribed , onUnsubscribed , put , put , put , put , put , put , put , put , remove , remove , stable , start , stop , subscribe , toNode , unsubscribe , validateChild
-
-
-
-
-Methods inherited from class org.iot.dsa.logging.DSLogger
-admin , admin , admin , debug , debug , debug , error , error , error , fatal , fatal , fatal , fine , fine , fine , info , info , info , trace , trace , trace , warn , warn , warn
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.lang.Iterable
-forEach, spliterator
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSMainNode
-public DSMainNode()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getLink
-public DSLink getLink()
-The parent link or null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSPermissionException (dslink-core 0.19.0 API)
-DSPermissionException (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
- DSRequestException (dslink-core 0.19.0 API)
-DSRequestException (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-org.iot.dsa.dslink.DSRequestException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.StringgetDetail Additional information to supply to the remote endpoint.
-
-
-voidsetDetail Overrides the default detail which is the stack trace of this exception.
-
-
-voidsetDetail Overrides the default detail which is the stack trace of this exception.
-
-
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSSysNode (dslink-core 0.19.0 API)
-DSSysNode (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSSysNode
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSNode
-add , childCount , clear , contains , copy , declareDefault , fire , fire , get , getElement , getFirst , getFirstInfo , getFirstNodeInfo , getInfo , getInfo , getLast , getLastInfo , getMetadata , getName , getNode , getParent , getPath , getValue , isDefaultInstance , isEqual , isIdentical , isNode , isNull , isRunning , isStable , isStarted , isStopped , isSubscribed , isSubscribed , isSubscribed , iterateNodes , iterateValues , iterator , onChildAdded , onChildChanged , onChildRemoved , onInfoChanged , onSet , onSet , onStable , onStarted , onStopped , onSubscribe , onSubscribed , onSubscribed , onUnsubscribe , onUnsubscribed , onUnsubscribed , put , put , put , put , put , put , put , put , remove , remove , stable , start , stop , subscribe , toNode , unsubscribe , validateChild
-
-
-
-
-Methods inherited from class org.iot.dsa.logging.DSLogger
-admin , admin , admin , debug , debug , debug , error , error , error , fatal , fatal , fatal , fine , fine , fine , info , info , info , trace , trace , trace , warn , warn , warn
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.lang.Iterable
-forEach, spliterator
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSSysNode
-public DSSysNode()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-declareDefaults
-protected void declareDefaults()
-Description copied from class: DSNode The is only called once for each class. It's purpose is to define the default children of
- the node subtype. Use the declareDefault method to add non-removable children that all
- runtime instances should have. Be sure to call super.declareDefaults().
-
-Overrides: declareDefaults DSNode See Also: To create non-removable children.
-
-
-
-
-
-
-
-
-
-
-
-getLink
-public DSLink getLink()
-
-
-
-
-
-
-
-
-
-
-
-onInvoke
-public ActionResult onInvoke(DSInfo action,
- ActionInvocation invocation)
-Description copied from class: DSNode Override point, called by the default implementation of DSAction.invoke. You should call
- super.onInvoke if you do not handle an incoming invocation. However, do not call super if
- you do.
-
-Overrides: onInvoke DSNode Parameters: action - Child info for the action, you can declare a field for the action info for
- quick instance comparison.invocation - Details about the incoming invoke as well as the mechanism to send updates
- over an open stream.Returns: It is okay to return null if the action result type is void.
-See Also: DSAction.invoke(DSInfo, ActionInvocation)
-
-
-
-
-
-
-
-validateParent
-protected void validateParent(DSNode node)
-Description copied from class: DSNode Override point, throw a meaningful IllegalArgumentException if the parent is not allowed
-
-Overrides: validateParent DSNode
-
-
-
-
-
-
-
DSUnsupportedException (dslink-core 0.19.0 API)
-DSUnsupportedException (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr | Method
-
-
-
-
- org.iot.dsa.dslink (dslink-core 0.19.0 API)
-org.iot.dsa.dslink (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
Exceptions
-
-
org.iot.dsa.dslink (dslink-core 0.19.0 API)
-org.iot.dsa.dslink (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-DSIRequester
-Interface for submitting outbound requests.
-
-
-
-DSIResponder
-Interface for nodes in the node tree to manually handle requests.
-
-
-
-DSLinkConnection.Listener
-Intended for requester functionality so that requesters can know when to
- start and stop making requests.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSLink
-Represents an upstream connection, a node tree, and manages the lifecycle of both.
-
-
-
-DSLinkConfig
-Configuration options for starting a link.
-
-
-
-DSLinkConnection
-Represents an upstream connection with a broker.
-
-
-
-DSMainNode
-The root DSNode that triggers a link's custom functionality .
-
-
-
-DSSysNode
-The root of the system nodes.
-
-
-
-
-
-
-
-
-
-
-
-
-
Package org.iot.dsa.dslink Description
-
DSLink is the main entry point for an application.
-
org.iot.dsa.dslink Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.dslink Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-java.lang.Object
-
-org.iot.dsa.dslink.DSLinkConfig DSILevels )
-org.iot.dsa.logging.DSLogger DSILevels )
-
-org.iot.dsa.node.DSNode DSIObject , java.lang.Iterable<T>)
-
-
-
-
-java.lang.Throwable (implements java.io.Serializable)
-
-java.lang.Exception
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
Interface Hierarchy
-
-
AbstractInvokeHandler (dslink-core 0.19.0 API)
-AbstractInvokeHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.dslink.requester.AbstractInvokeHandler
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
AbstractListHandler (dslink-core 0.19.0 API)
-AbstractListHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.dslink.requester.AbstractListHandler
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
AbstractSubscribeHandler (dslink-core 0.19.0 API)
-AbstractSubscribeHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.dslink.requester.AbstractSubscribeHandler
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.StringgetPath Returns the value passed to onInit.
-
-
-intgetQos Returns the value passed to onInit.
-
-
-OutboundStream getStream Returns the value passed to onInit.
-
-
-voidonInit OutboundStream stream)Sets the fields so they can be accessed via the corresponding getters.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
ErrorType (dslink-core 0.19.0 API)
-ErrorType (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Enum<ErrorType >
-
-
-org.iot.dsa.dslink.requester.ErrorType
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static java.lang.RuntimeExceptionmakeException ErrorType type,
- java.lang.String message)
-
-static ErrorType valueOf Returns the enum constant of this type with the specified name.
-
-
-static ErrorType []values Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static ErrorType valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
-
-
-
-
OutboundInvokeHandler.Mode (dslink-core 0.19.0 API)
-OutboundInvokeHandler.Mode (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static OutboundInvokeHandler.Mode valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
OutboundInvokeHandler (dslink-core 0.19.0 API)
-OutboundInvokeHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidonColumns DSList list)Called whenever columns are received.
-
-
-voidonInit DSMap params,
- OutboundStream stream)Called by the requester before returning from the invoke method.
-
-
-voidonInsert DSList rows)Called when the given rows should be inserted at the given index.
-
-
-voidonMode OutboundInvokeHandler.Mode mode)Called whenever a mode is received.
-
-
-voidonReplace DSList rows)The rows starting and ending with the given indexes should be removed and the given rows
- inserted at the start index.
-
-
-voidonTableMeta DSMap map)Called whenever metadata for the entire table is received.
-
-
-voidonUpdate DSList row)Called for every row.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-onColumns
-void onColumns(DSList list)
-Called whenever columns are received. Columns should be appended to any existing columns
- unless a refresh is called, in which case any new columns replace the existing columns.
-
-Parameters: list - A list of maps.
-
-
-
-
-
-
-
-onInit
-void onInit(java.lang.String path,
- DSMap params,
- OutboundStream stream)
-Called by the requester before returning from the invoke method.
-
-Parameters: path - Path being listed.params - Parameter to the invoke method.stream - Mechanism to close the request stream.
-
-
-
-
-
-
-
-onInsert
-void onInsert(int index,
- DSList rows)
-Called when the given rows should be inserted at the given index.
-
-Parameters: index - Where to insert the given rows.rows - What to insert at the given index.
-
-
-
-
-
-
-
-
-
-
-
-onReplace
-void onReplace(int start,
- int end,
- DSList rows)
-The rows starting and ending with the given indexes should be removed and the given rows
- inserted at the start index.
-
-Parameters: start - First inclusive of rows to be replaced.end - Last inclusive index of rows to be replaced.rows - What to insert at the starting index.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- OutboundListHandler (dslink-core 0.19.0 API)
-OutboundListHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidonInit OutboundStream stream)Called by the requester before returning from the list method.
-
-
-voidonInitialized Called once the initial state of the target has been transmitted.
-
-
-voidonRemove Only called after onOpen(), indicates something about the target of the request has been
- removed.
-
-
-voidonUpdate DSElement value)Called to provide a value for node metadata, attribute or child.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-onInit
-void onInit(java.lang.String path,
- OutboundStream stream)
-Called by the requester before returning from the list method.
-
-Parameters: path - Parameter to the list method.stream - Mechanism to close the request stream.
-
-
-
-
-
-
-
-
-
-
-
-onRemove
-void onRemove(java.lang.String name)
-Only called after onOpen(), indicates something about the target of the request has been
- removed.
-
-Parameters: name - Name of the the thing that has been removed.
-
-
-
-
-
-
-
-onUpdate
-void onUpdate(java.lang.String name,
- DSElement value)
-Called to provide a value for node metadata, attribute or child. After onOpen is called
- these represent changes of state.
-
-Parameters: name - Node metadata starts with $, attributes @, otherwise represents a child.value - If a child, will be a map.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- OutboundRequestHandler (dslink-core 0.19.0 API)
-OutboundRequestHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidonClose Callback for when the request stream is closed, no matter how or by who.
-
-
-voidonError ErrorType type,
- java.lang.String msg)Callback for when an error is received.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-onError
-void onError(ErrorType type,
- java.lang.String msg)
-Callback for when an error is received. onClose will also be called after this.
- Does nothing by default.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- OutboundStream (dslink-core 0.19.0 API)
-OutboundStream (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- OutboundSubscribeHandler (dslink-core 0.19.0 API)
-OutboundSubscribeHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-onInit
-void onInit(java.lang.String path,
- int qos,
- OutboundStream stream)
-Called by the requester before returning from the subscribe method.
-
-Parameters: path - Who is being subscribed.qos - Quality of service, 0-3.stream - Mechanism to close the request stream.
-
-
-
-
-
-
-
-onUpdate
-void onUpdate(DSDateTime dateTime,
- DSElement value,
- DSStatus status)
-Subscription update mechanism.
-
-Parameters: dateTime - Timestamp of the value.value - The update value.status - The status of the value, never null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- SimpleInvokeHandler (dslink-core 0.19.0 API)
-SimpleInvokeHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSList getResult Waits for the stream to close before returning, or the timeout to occur.
-
-
-booleanisAutoClose True by default, whether or not to close the stream upon receiving the first result.
-
-
-voidonClose Causes getResult to return.
-
-
-voidonColumns DSList list)Does nothing.
-
-
-voidonError ErrorType type,
- java.lang.String msg)Will create an exception to be thrown by getResult.
-
-
-voidonInsert DSList rows)Will result in an error since tables and streams are not supported.
-
-
-voidonMode OutboundInvokeHandler.Mode mode)Does nothing.
-
-
-voidonReplace DSList rows)Will result in an error since tables and streams are not supported.
-
-
-voidonTableMeta DSMap map)Called whenever metadata for the entire table is received.
-
-
-voidonUpdate DSList row)Captures the result and if auto-close is true, closes the stream.
-
-
-SimpleInvokeHandler setAutoClose Whether or not to auto close the stream on the first update.
-
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getResult
-public DSList getResult(long timeout)
-Waits for the stream to close before returning, or the timeout to occur.
-
-Parameters: timeout - Passed to Object.waitReturns: Null, or the first update.
-Throws: java.lang.RuntimeException - if there is a timeout, or if there are any errors.
-
-
-
-
-
-
-
-isAutoClose
-public boolean isAutoClose()
-True by default, whether or not to close the stream upon receiving the first result.
-
-
-
-
-
-
-
-
-
-
-
-onError
-public void onError(ErrorType type,
- java.lang.String msg)
-Will create an exception to be thrown by getResult.
-
-
-
-
-
-
-
-
-
-
-
-onInsert
-public void onInsert(int index,
- DSList rows)
-Will result in an error since tables and streams are not supported.
-
-Parameters: index - Where to insert the given rows.rows - What to insert at the given index.
-
-
-
-
-
-
-
-
-
-
-
-onReplace
-public void onReplace(int start,
- int end,
- DSList rows)
-Will result in an error since tables and streams are not supported.
-
-Parameters: start - First inclusive of rows to be replaced.end - Last inclusive index of rows to be replaced.rows - What to insert at the starting index.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-setAutoClose
-public SimpleInvokeHandler setAutoClose(boolean arg)
-Whether or not to auto close the stream on the first update. True by default, this
- only needs to be called to disable.
-
-
-
-
-
-
-
SimpleRequestHandler (dslink-core 0.19.0 API)
-SimpleRequestHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.dslink.requester.SimpleRequestHandler
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static SimpleRequestHandler DEFAULT An instance that can be used for those requests where the callbacks don't really matter.
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-onClose
-public void onClose()
-Does nothing by default.
-
-
-
- Callback for when the request stream is closed, no matter how or by who. Will be called if
- there is an error as well.
-Specified by: onClose OutboundRequestHandler
-
-
-
-
-
-
-
-
-
-
-
org.iot.dsa.dslink.requester (dslink-core 0.19.0 API)
-org.iot.dsa.dslink.requester (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.iot.dsa.dslink.requester (dslink-core 0.19.0 API)
-org.iot.dsa.dslink.requester (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-OutboundInvokeHandler
-Callback mechanism passed to the invoke method on DSIRequester.
-
-
-
-OutboundListHandler
-Callback mechanism passed to the list method on DSIRequester.
-
-
-
-OutboundRequestHandler
-Callbacks common to all outbound requests.
-
-
-
-OutboundStream
-Mechanism for the requester to close outbound requests.
-
-
-
-OutboundSubscribeHandler
-Callback mechanism passed to the subscribe method in the requester.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-AbstractInvokeHandler
-Convenience implementation of the callback passed to the invoke method in the requester.
-
-
-
-AbstractListHandler
-Convenience implementation of the handler passed to the invoke method in the requester.
-
-
-
-AbstractSubscribeHandler
-Convenience implementation of the handler passed to the subscribe method in the requester.
-
-
-
-SimpleInvokeHandler
-Action handler for non-tables/streams.
-
-
-
-SimpleRequestHandler
-Empty callback implementations.
-
-
-
-
-
-
-
-
-
-
-
-
-
Package org.iot.dsa.dslink.requester Description
-
API for implementing requesters without having to modeling everything in the node tree.
-
org.iot.dsa.dslink.requester Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.dslink.requester Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
ApiObject (dslink-core 0.19.0 API)
-ApiObject (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-ActionSpec getAction The action, should only be called if isAction() returns true.
-
-
-java.util.Iterator<ApiObject >getChildren Iterator of child objects, should only be called if hasChildren() returns true.
-
-
-voidgetMetadata DSMap bucket)
-
-java.lang.StringgetName The display name.
-
-
-DSIValue getValue Value of the object, should only be called if isValue() returns true.
-
-
-booleanhasChildren True if getChildren() can be called.
-
-
-booleanisAction True if the object is an action.
-
-
-booleanisAdmin Whether or not this object requires configuration permission to read/write.
-
-
-booleanisHidden True if the object should ignored (not be exposed through the api).
-
-
-booleanisReadOnly True if the object is a value and cannot be written.
-
-
-booleanisValue True if getValue() can be called.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-getChildren
-java.util.Iterator<ApiObject > getChildren()
-Iterator of child objects, should only be called if hasChildren() returns true.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- InboundInvokeRequest (dslink-core 0.19.0 API)
-InboundInvokeRequest (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
- InboundListRequest (dslink-core 0.19.0 API)
-InboundListRequest (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidchildAdded ApiObject child)The responder should call this whenever a child is added.
-
-
-voidchildRemoved ApiObject child)The responder should call this whenever a child is removed.
-
-
-voidclose Allows the responder to forcefully close the list stream.
-
-
-voidclose Allows the responder to forcefully close the list stream.
-
-
-booleanisOpen Whether or not the list stream is still open.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- InboundRequest (dslink-core 0.19.0 API)
-InboundRequest (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- InboundSetRequest (dslink-core 0.19.0 API)
-InboundSetRequest (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getValue
-DSElement getValue()The value to set.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- InboundSubscribeRequest (dslink-core 0.19.0 API)
-InboundSubscribeRequest (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidclose Allows the responder to forcefully terminate the subscription.
-
-
-java.lang.IntegergetSubscriptionId Unique subscription id for this path.
-
-
-voidupdate DSIValue value,
- DSStatus quality)The responder should call this when first received and then whenever the value or status
- changes.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-update
-void update(long timestamp,
- DSIValue value,
- DSStatus quality)
-The responder should call this when first received and then whenever the value or status
- changes.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- OutboundListResponse (dslink-core 0.19.0 API)
-OutboundListResponse (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-public interface OutboundListResponse
-The responder is responsible for returning this upon notification of a list request. The link
- will encode the target first, then then children. If there are many children, the link may break
- it into several messages.
-
-See Also: DSIResponder.onList(InboundListRequest)
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- SubscriptionCloseHandler (dslink-core 0.19.0 API)
-SubscriptionCloseHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidonClose Will be called no matter how the subscription is terminated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.iot.dsa.dslink.responder (dslink-core 0.19.0 API)
-org.iot.dsa.dslink.responder (dslink-core 0.20.0 API)
-org.iot.dsa.dslink.responder (dslink-core 0.19.0 API)
-org.iot.dsa.dslink.responder (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-ApiObject
-Can be a node, value or an action.
-
-
-
-InboundInvokeRequest
-See ActionInvocation for the real meat.
-
-
-
-InboundListRequest
-The details about an incoming list request passed to the responder.
-
-
-
-InboundRequest
-Common to all incoming requests.
-
-
-
-InboundSetRequest
-
-
-InboundSubscribeRequest
-The details about an incoming subscribe request passed to the responder.
-
-
-
-OutboundListResponse
-The responder is responsible for returning this upon notification of a list request.
-
-
-
-SubscriptionCloseHandler
-The responder returns this from the subscription request notification method so the link can
- notify the responder whenever a subscription is terminated.
-
-
-
-
-
-
-
-
-
-
Package org.iot.dsa.dslink.responder Description
-
API for implementing responders without having modeling everything in the node tree.
-
org.iot.dsa.dslink.responder Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.dslink.responder Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/javadoc/org/iot/dsa/io/AbstractReader.html b/docs/javadoc/org/iot/dsa/io/AbstractReader.html
deleted file mode 100644
index b9a1e7b7..00000000
--- a/docs/javadoc/org/iot/dsa/io/AbstractReader.html
+++ /dev/null
@@ -1,774 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-AbstractReader (dslink-core 0.19.0 API)
-AbstractReader (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.io.AbstractReader
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-protected booleanvalBoolean
-
-protected byte[]valBytes
-
-protected longvalLong
-
-protected doublevalReal
-
-protected java.lang.StringvalString
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-AbstractReader
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-valReal
-protected double valReal
-
-
-
-
-
-
-
-valLong
-protected long valLong
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-AbstractReader
-public AbstractReader()
-
-
-
-
-
-
-
-
-
AbstractWriter (dslink-core 0.19.0 API)
-AbstractWriter (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.io.AbstractWriter
-
-
-
-
-
-
-
-All Implemented Interfaces:
-java.io.Closeable, java.lang.AutoCloseable, DSIWriter
-
-
-Direct Known Subclasses:
-AbstractJsonWriter
-public abstract class AbstractWriter
-extends java.lang.Object
-implements java.io.Closeable, DSIWriter
-Basic implementation of DSWriter. Subclasses must implement the abstract methods which all start
- with write.
-
-See Also: DSIWriter
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-protected booleanprettyPrint Subclasses can use this if applicable.
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-AbstractWriter
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-AbstractWriter
-public AbstractWriter()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-key
-public AbstractWriter key(java.lang.CharSequence arg)
-
-Write a key in the current map. Cannot be called in a list, must be followed by a call to
- one of the value methods.
-
-Specified by: key DSIWriter
-
-
-
-
-
-
-
-length
-public int length()
-Returns 0 by default.
-
-Specified by: length DSIWriter
-
-
-
-
-
-
-
-
-
-
-
-value
-public AbstractWriter value(DSElement arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String). This can be used to encode an entire graph.
-
-Specified by: value DSIWriter
-
-
-
-
-
-
-
-value
-public AbstractWriter value(boolean arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Specified by: value DSIWriter
-
-
-
-
-
-
-
-value
-public AbstractWriter value(byte[] arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Specified by: value DSIWriter
-
-
-
-
-
-
-
-value
-public AbstractWriter value(double arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Specified by: value DSIWriter
-
-
-
-
-
-
-
-value
-public AbstractWriter value(int arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Specified by: value DSIWriter
-
-
-
-
-
-
-
-value
-public AbstractWriter value(long arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Specified by: value DSIWriter
-
-
-
-
-
-
-
-value
-public AbstractWriter value(java.lang.String arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Specified by: value DSIWriter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-writeNewLineIndent
-protected void writeNewLineIndent()
- throws java.io.IOException
-Override point for subclasses which perform use pretty printing, such as json. Does nothing
- by default.
-
-Throws: java.io.IOExceptionSee Also: getDepth()
-
-
-
-
-
-
-
-
-
-
-
-writeSeparator
-protected abstract void writeSeparator()
- throws java.io.IOException
-Write a value separator, such as the comma in json.
-
-Throws: java.io.IOException
-
-
-
-
-
-
-
-writeValue
-protected abstract void writeValue(java.lang.CharSequence arg)
- throws java.io.IOException
-Write the value, which will never be null.
-
-Throws: java.io.IOException
-
-
-
-
-
-
-
DSBase64 (dslink-core 0.19.0 API)
-DSBase64 (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.io.DSBase64
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSBase64
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static byte[]decode Decodes a base 64 encoded string.
-
-
-static java.lang.Stringencode Encodes the bytes into a single line string with no padding.
-
-
-static java.lang.Stringencode Encodes the buffer into a String with the given line length.
-
-
-static java.lang.StringencodeUrl Encodes to a URL safe base64 string.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSBase64
-public DSBase64()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-encode
-public static java.lang.String encode(byte[] buf,
- int linelen)
-Encodes the buffer into a String with the given line length. Lines will be padded to the
- given length.
-
-Parameters: buf - The bytes to encode.linelen - A number greater than zero limits the number of characters before an
- interleaving newline.Returns: The encoding.
-
-
-
-
-
-
-
-
-
-
-
-
DSIReader.Token (dslink-core 0.19.0 API)
-DSIReader.Token (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-All Implemented Interfaces:
-java.io.Serializable, java.lang.Comparable<DSIReader.Token >
-
-
-Enclosing interface:
-DSIReader
-public static enum DSIReader.Token
-extends java.lang.Enum<DSIReader.Token >
-Represents the state of the reader, and determines which getter should be called next.
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static DSIReader.Token valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
DSIReader (dslink-core 0.19.0 API)
-DSIReader (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Interface and Description
-
-
-static class DSIReader.Token Represents the state of the reader, and determines which getter should be called next.
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidclose Close the input.
-
-
-booleangetBoolean Returns the value when last() == BOOLEAN.
-
-
-byte[]getBytes Returns the value when last() == BYTES.
-
-
-doublegetDouble Returns the value when last() == DOUBLE.
-
-
-DSElement getElement Returns the DSElement when last() == raw type or ROOT.
-
-
-DSList getList This should only be called when last() == BEGIN_LIST and it will decodeKeys the entire
- list.
-
-
-longgetLong Returns the value when last() == LONG.
-
-
-DSMap getMap This should only be called when last() == BEGIN_MAP and it will decodeKeys the entire map.
-
-
-java.lang.StringgetString Returns the value when last() == STRING.
-
-
-DSIReader.Token last The last value returned from next().
-
-
-DSIReader.Token next Advances the reader to the next item and returns the token representing it's current state.
-
-
-DSIReader reset Sets last() == ROOT.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-close
-void close()
-Close the input.
-
-Specified by: close in interface java.lang.AutoCloseableSpecified by: close in interface java.io.Closeable
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-reset
-DSIReader reset()Sets last() == ROOT.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIWriter (dslink-core 0.19.0 API)
-DSIWriter (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-endList
-DSIWriter endList()End the current list.
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-endMap
-DSIWriter endMap()End the current map.
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-
-
-
-
-key
-DSIWriter key(java.lang.CharSequence key)Write a key in the current map. Cannot be called in a list, must be followed by a call to
- one of the value methods.
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-value
-DSIWriter value(DSElement arg)Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String). This can be used to encode an entire graph.
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-value
-DSIWriter value(boolean arg)Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-value
-DSIWriter value(byte[] arg)Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-value
-DSIWriter value(double arg)Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-
-
-
-
-value
-DSIWriter value(long arg)Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-value
-DSIWriter value(java.lang.String arg)Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String).
-
-Throws: java.lang.IllegalStateException - when improperly called.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- NodeDecoder (dslink-core 0.19.0 API)
-NodeDecoder (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.io.NodeDecoder
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- NodeEncoder (dslink-core 0.19.0 API)
-NodeEncoder (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.io.NodeEncoder
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-encode
-public static DSIWriter encode(DSIWriter out,
- DSNode node)
-Writes the node tree to the given writer. Flushes but does not close the writer.
-
-Parameters: out - Where to write the node, also the return value (unclosed).node - What to encode.Returns: The writer parameter, flushed, but not closed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- AbstractJsonWriter (dslink-core 0.19.0 API)
-AbstractJsonWriter (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class org.iot.dsa.io.AbstractWriter
-beginList , beginList , beginMap , beginMap , endList , endMap , getDepth , key , length , reset , value , value , value , value , value , value
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.lang.Appendable
-append, append, append
-
-
-
-
-Methods inherited from interface org.iot.dsa.io.DSIWriter
-beginList , beginList , beginMap , beginMap , close , endList , endMap , flush , key , length , reset , value , value , value , value , value , value
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-append
-public abstract AbstractJsonWriter append(char[] ch,
- int off,
- int len)
-Append the characters and return this.
-
-
-
-
-
-
-
-
-
-
-
-value
-public AbstractWriter value(DSElement arg)
-
-Write a value to the map or list. If in a map, this must have been preceded by a call to
- key(String). This can be used to encode an entire graph.
-
-Specified by: value DSIWriter Overrides: value AbstractWriter
-
-
-
-
-
-
-
-writeSeparator
-protected void writeSeparator()
- throws java.io.IOException
-
-Write a value separator, such as the comma in json.
-
-Specified by: writeSeparator AbstractWriter Throws: java.io.IOException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-writeValue
-protected void writeValue(java.lang.CharSequence arg)
- throws java.io.IOException
-
-Write the value, which will never be null.
-
-Specified by: writeValue AbstractWriter Throws: java.io.IOException
-
-
-
-
-
-
-
JsonAppender (dslink-core 0.19.0 API)
-JsonAppender (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-JsonAppender Be sure to call one of the setOutput methods.
-
-
-JsonAppender Will write directly to the given appendable.
-
-
-JsonAppender Creates an underlying FileWriter.
-
-
-JsonAppender Will create a zip file using the zipFileName as file name inside the zip.
-
-
-JsonAppender Creates an underlying OutputStreamWriter.
-
-
-JsonAppender Will write a zip file to the given stream.
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.Appendableappend Append the char and return this.
-
-
-JsonAppender append Append the chars and return this.
-
-
-java.lang.Appendableappend Append the chars and return this.
-
-
-java.lang.Appendableappend Append the chars and return this.
-
-
-voidclose Close the stream.
-
-
-JsonAppender flush Flush the stream.
-
-
-booleanisZip Whether or not this is zipping the output.
-
-
-JsonAppender reset Clears the state of the writer.
-
-
-JsonAppender setOutput Sets the sink, resets the state and returns this.
-
-
-JsonAppender setOutput Sets the sink, resets the state and returns this.
-
-
-JsonAppender setOutput Will create a zip file using the zipFileName as file name inside the zip.
-
-
-JsonAppender setOutput Sets the sink, resets the state and returns this.
-
-
-JsonAppender setOutput Will write a zip file to the given stream.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.io.json.AbstractJsonWriter
-setPrettyPrint , value , write , write , write , write , writeKey , writeKeyValueSeparator , writeListEnd , writeListStart , writeMapEnd , writeMapStart , writeNewLineIndent , writeNull , writeSeparator , writeValue
-
-
-
-
-Methods inherited from class org.iot.dsa.io.AbstractWriter
-beginList , beginList , beginMap , beginMap , endList , endMap , getDepth , key , length , value , value , value , value , value , value
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface org.iot.dsa.io.DSIWriter
-beginList , beginList , beginMap , beginMap , endList , endMap , key , length , value , value , value , value , value , value
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-JsonAppender
-public JsonAppender(java.io.File file,
- java.lang.String zipFileName)
-Will create a zip file using the zipFileName as file name inside the zip.
-
-
-
-
-
-
-
-
-
-
-
-JsonAppender
-public JsonAppender(java.io.OutputStream out,
- java.lang.String zipFileName)
-Will write a zip file to the given stream.
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-append
-public JsonAppender append(char[] ch,
- int off,
- int len)
-Append the chars and return this. Can be used for custom formatting.
-
-Specified by: append AbstractJsonWriter
-
-
-
-
-
-
-
-
-
-
-
-append
-public java.lang.Appendable append(java.lang.CharSequence csq,
- int start,
- int end)
-Append the chars and return this. Can be used for custom formatting.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-setOutput
-public JsonAppender setOutput(java.lang.Appendable arg)
-Sets the sink, resets the state and returns this.
-
-
-
-
-
-
-
-
-
-
-
-setOutput
-public JsonAppender setOutput(java.io.File file,
- java.lang.String zipFileName)
-Will create a zip file using the zipFileName as file name inside the zip. Resets the state
- and returns this.
-
-
-
-
-
-
-
-setOutput
-public JsonAppender setOutput(java.io.OutputStream arg)
-Sets the sink, resets the state and returns this.
-
-
-
-
-
-
-
-setOutput
-public JsonAppender setOutput(java.io.OutputStream out,
- java.lang.String zipFileName)
-Will write a zip file to the given stream. Resets the state and returns this.
-
-
-
-
-
-
-
JsonConstants (dslink-core 0.19.0 API)
-JsonConstants (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field | Constr |
-Method
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static java.lang.StringDBL_NAN How Double.NaN is encoded: "\\u001BNaN"
-
-
-static java.lang.StringDBL_NEG_INF How Double.NEGATIVE_INFINITY is encoded: "\\u001B-Infinity"
-
-
-static java.lang.StringDBL_POS_INF How Double.POSITIVE_INFINITY is encoded: "\\u001BInfinity"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field | Constr |
-Method
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
- JsonReader (dslink-core 0.19.0 API)
-JsonReader (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-All Implemented Interfaces:
-java.io.Closeable, java.lang.AutoCloseable, DSIReader , JsonConstants
-
-public class JsonReader
-extends AbstractReader
-implements DSIReader , JsonConstants
-Json implementation of DSReader. The same instance can be re-used with the setInput methods.
- This class is not thread safe.
-
-See Also: DSIReader
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-voidclose Close the input.
-
-
-DSIReader.Token next Subclasses must override this, read the next item from the stream, then call one of the
- setXxx methods.
-
-
-JsonReader reset Sets last() == ROOT.
-
-
-JsonReader setInput Sets the input source, resets to ROOT, and returns this.
-
-
-JsonReader setInput Sets the input source, resets to ROOT, and returns this.
-
-
-JsonReader setInput Sets the input source, resets to ROOT, and returns this.
-
-
-JsonReader setInput Sets the input source, resets to ROOT, and returns this.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.io.AbstractReader
-getBoolean , getBytes , getDouble , getElement , getList , getLong , getMap , getString , last , setBeginList , setBeginMap , setEndInput , setEndList , setEndMap , setNextValue , setNextValue , setNextValue , setNextValue , setNextValue , setNextValueNull
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-JsonReader
-public JsonReader()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-close
-public void close()
-
-Close the input.
-
-Specified by: close in interface java.io.CloseableSpecified by: close in interface java.lang.AutoCloseableSpecified by: close DSIReader
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-setInput
-public JsonReader setInput(java.lang.CharSequence in)
-Sets the input source, resets to ROOT, and returns this.
-
-
-
-
-
-
-
-setInput
-public JsonReader setInput(java.io.File file)
-Sets the input source, resets to ROOT, and returns this.
-
-
-
-
-
-
-
-setInput
-public JsonReader setInput(java.io.InputStream inputStream,
- java.lang.String charset)
-Sets the input source, resets to ROOT, and returns this.
-
-
-
-
-
-
-
-setInput
-public JsonReader setInput(java.io.Reader reader)
-Sets the input source, resets to ROOT, and returns this.
-
-
-
-
-
-
-
JsonWriter (dslink-core 0.19.0 API)
-JsonWriter (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-JsonWriter Be sure to call one of the setOutput methods.
-
-
-JsonWriter Creates an underlying FileWriter.
-
-
-JsonWriter Will create a zip file using the zipFileName as file name inside the zip.
-
-
-JsonWriter Creates an underlying OutputStreamWriter.
-
-
-JsonWriter Will write a zip file to the given stream.
-
-
-JsonWriter
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.Appendableappend
-
-AbstractJsonWriter append Append the chars and return this.
-
-
-java.lang.Appendableappend
-
-java.lang.Appendableappend Append the chars and return this.
-
-
-voidclose Close the stream.
-
-
-JsonWriter flush Flush the stream.
-
-
-JsonWriter reset Clears the state of the writer.
-
-
-JsonWriter setOutput Sets the sink, resets the state and returns this.
-
-
-JsonWriter setOutput Will create a zip file using the zipFileName as file name inside the zip.
-
-
-JsonWriter setOutput Sets the sink, resets the state and returns this.
-
-
-JsonWriter setOutput Will write a zip file to the given stream.
-
-
-JsonWriter setOutput Sets the sink, resets the state and returns this.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.io.json.AbstractJsonWriter
-setPrettyPrint , value , write , write , write , write , writeKey , writeKeyValueSeparator , writeListEnd , writeListStart , writeMapEnd , writeMapStart , writeNewLineIndent , writeNull , writeSeparator , writeValue
-
-
-
-
-Methods inherited from class org.iot.dsa.io.AbstractWriter
-beginList , beginList , beginMap , beginMap , endList , endMap , getDepth , key , length , value , value , value , value , value , value
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface org.iot.dsa.io.DSIWriter
-beginList , beginList , beginMap , beginMap , endList , endMap , key , length , value , value , value , value , value , value
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-JsonWriter
-public JsonWriter(java.io.File file,
- java.lang.String zipFileName)
-Will create a zip file using the zipFileName as file name inside the zip.
-
-
-
-
-
-
-
-
-
-
-
-JsonWriter
-public JsonWriter(java.io.OutputStream out,
- java.lang.String zipFileName)
-Will write a zip file to the given stream.
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-setOutput
-public JsonWriter setOutput(java.io.File file,
- java.lang.String zipFileName)
-Will create a zip file using the zipFileName as file name inside the zip. Resets the state
- and returns this.
-
-
-
-
-
-
-
-setOutput
-public JsonWriter setOutput(java.io.OutputStream arg)
-Sets the sink, resets the state and returns this.
-
-
-
-
-
-
-
-setOutput
-public JsonWriter setOutput(java.io.OutputStream out,
- java.lang.String zipFileName)
-Will write a zip file to the given stream. Resets the state and returns this.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-append
-public java.lang.Appendable append(java.lang.CharSequence csq,
- int start,
- int end)
- throws java.io.IOException
-Append the chars and return this. Can be used for custom formatting.
-
-Throws: java.io.IOException
-
-
-
-
-
-
-
-
-
-
-
org.iot.dsa.io.json (dslink-core 0.19.0 API)
-org.iot.dsa.io.json (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
org.iot.dsa.io.json (dslink-core 0.19.0 API)
-org.iot.dsa.io.json (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-JsonConstants
-Useful constants.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-AbstractJsonWriter
-
-
-JsonAppender
-Json implementation of DSWriter intended for Appendables such as StringBuilders.
-
-
-
-JsonReader
-Json implementation of DSReader.
-
-
-
-JsonWriter
-Json implementation of DSWriter intended for OutputStreams and Writers.
-
-
-
-
-
-
-
org.iot.dsa.io.json Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.io.json Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
org.iot.dsa.io (dslink-core 0.19.0 API)
-org.iot.dsa.io (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.iot.dsa.io (dslink-core 0.19.0 API)
-org.iot.dsa.io (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-DSIReader
-A decoder that can be used to get an entire graph in pieces, or one large group, or somewhere in
- between.
-
-
-
-DSIWriter
-An encoder that can be used to encode large graphs with or without object instances.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-AbstractReader
-Basic implementation of DSReader.
-
-
-
-AbstractWriter
-Basic implementation of DSWriter.
-
-
-
-DSBase64
-Thread-safe Base64 encoder and decoder.
-
-
-
-NodeDecoder
-Decodes a node (tree) that was encoded with NodeEncoder.
-
-
-
-NodeEncoder
-Encodes a node tree using a compact JSON schema.
-
-
-
-
-
-
-
-Enum Summary
-Enum
-Description
-
-
-
-DSIReader.Token
-Represents the state of the reader, and determines which getter should be called next.
-
-
-
-
-
-
-
-
-
-
Package org.iot.dsa.io Description
-
Node serialization and streaming abstraction for JSON and MsgPack.
-
org.iot.dsa.io Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.io Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-java.lang.AutoCloseable
-
-
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
AsyncLogHandler (dslink-core 0.19.0 API)
-AsyncLogHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.util.logging.Handler
-
-
-org.iot.dsa.logging.AsyncLogHandler
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-voidclose Closes the PrintStream, terminates the write thread and performs houseKeeping.
-
-
-voidflush
-
-longgetHouseKeepingIntervalMillis Ten seconds by default, this is a guideline more than anything else.
-
-
-protected java.io.PrintStreamgetOut The sink for formatted messages.
-
-
-protected abstract java.lang.StringgetThreadName Used to name the thread that processes logging records.
-
-
-protected voidhouseKeeping Subclass hook for activities such as rolling files and cleaning up old garbage.
-
-
-voidpublish Enqueues the record for the write thread.
-
-
-AsyncLogHandler setMaxQueueSize
-
-protected AsyncLogHandler setOut Sets the sink for formatted messages.
-
-
-protected voidstart This must be called for the handler to actually do anything.
-
-
-protected voidwrite Formats and writes the logging record the underlying stream.
-
-
-
-
-
-
-Methods inherited from class java.util.logging.Handler
-getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-AsyncLogHandler
-public AsyncLogHandler()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-flush
-public void flush()
-
-Specified by: flush in class java.util.logging.Handler
-
-
-
-
-
-
-
-getHouseKeepingIntervalMillis
-public long getHouseKeepingIntervalMillis()
-Ten seconds by default, this is a guideline more than anything else. Housekeeping can be
- called sooner during low activity periods.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-houseKeeping
-protected void houseKeeping()
-Subclass hook for activities such as rolling files and cleaning up old garbage. Called during
- periods of inactivity or after the houseKeepingInterval is exceeded. Does nothing by default
- and flush will be called just prior to this.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSILevels (dslink-core 0.19.0 API)
-DSILevels (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field | Constr |
-Method
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static java.util.logging.Leveladmin
-
-static intADMIN
-
-static java.util.logging.Levelall
-
-static intCONFIG
-
-static java.util.logging.Leveldebug
-
-static intDEBUG
-
-static java.util.logging.Levelerror
-
-static intERROR
-
-static java.util.logging.Levelfatal
-
-static intFATAL
-
-static java.util.logging.Levelfine
-
-static intFINE
-
-static java.util.logging.Levelinfo
-
-static intINFO
-
-static java.util.logging.Leveloff
-
-static java.util.logging.Leveltrace
-
-static intTRACE
-
-static java.util.logging.Levelwarn
-
-static intWARN
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field | Constr |
-Method
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
- DSLogger (dslink-core 0.19.0 API)
-DSLogger (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.logging.DSLogger
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSLogger
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-booleanadmin True if the level is loggable.
-
-
-voidadmin
-
-voidadmin
-
-booleandebug True if the level is loggable.
-
-
-voiddebug Log a debug event.
-
-
-voiddebug Log a debug event.
-
-
-booleanerror True if the level is loggable.
-
-
-voiderror
-
-voiderror
-
-booleanfatal True if the level is loggable.
-
-
-voidfatal
-
-voidfatal
-
-booleanfine True if the level is loggable.
-
-
-voidfine Log a frequent event.
-
-
-voidfine Log a frequent event.
-
-
-protected java.lang.StringgetLogName Override point, returns the simple class name by default.
-
-
-booleaninfo True if the level is loggable.
-
-
-voidinfo Log an infrequent major lifecycle event.
-
-
-voidinfo Log an infrequent major lifecycle event.
-
-
-booleantrace True if the level is loggable.
-
-
-voidtrace Log a trace or verbose event.
-
-
-voidtrace Log a trace or verbose event.
-
-
-booleanwarn True if the level is loggable.
-
-
-voidwarn Log an unusual but not critical event.
-
-
-voidwarn Log an unusual but not critical event.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSLogger
-public DSLogger()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-warn
-public void warn(java.lang.Object msg,
- java.lang.Throwable x)
-Log an unusual but not critical event.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-info
-public void info(java.lang.Object msg,
- java.lang.Throwable x)
-Log an infrequent major lifecycle event.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSLogging (dslink-core 0.19.0 API)
-DSLogging (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.logging.DSLogging
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static intDEFAULT_BACKUP_THRESHOLD This is the threshold, not a hard limit: 10 megs by default.
-
-
-static intDEFAULT_MAX_BACKUPS The default number of backups to retain: 10 by default.
-
-
-static intDEFAULT_MAX_QUEUE Max async queue size: 2500 by default.
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static voidclose Closes all async log handlers.
-
-
-static java.util.logging.LoggergetDefaultLogger The default logger.
-
-
-static java.util.logging.LoggergetLogger Adds a FileLogHandler to the named logger, if there isn't one already.
-
-
-static voidsetDefaultLevel
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-DEFAULT_BACKUP_THRESHOLD
-public static int DEFAULT_BACKUP_THRESHOLD
-This is the threshold, not a hard limit: 10 megs by default.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-getLogger
-public static java.util.logging.Logger getLogger(java.lang.String name,
- java.io.File logFile)
-Adds a FileLogHandler to the named logger, if there isn't one already. This can be used
- repeatedly to acquire the same logger, but doing so would be inefficient. Use
- Logger.getLogger after this has installed the handler.
-
-Parameters: name - Log name.logFile - Where record the logging, may be null. Multiple logs can safely share the
- same file. If null, will route to System.out.
-
-
-
-
-
-
-
-
-
-
-
FileLogHandler (dslink-core 0.19.0 API)
-FileLogHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-java.util.logging.Handler
-
-
-
-
-
-
-
-
-
-
-All Implemented Interfaces:
-DSILevels
-public class FileLogHandler
-extends AsyncLogHandler
-Logs records to a file. When the file exceeds a certain size, it'll be zipped to a backup, and
- excess backups will be deleted.
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-Methods inherited from class java.util.logging.Handler
-getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getHandler
-public static FileLogHandler getHandler(java.io.File file)
-Will return an existing handler for the given file, or create a new one.
-
-
-
-
-
-
-
-getBackups
-public java.io.File[] getBackups()
-Backup files for this logging, found in the same directory as the active logging.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-houseKeeping
-protected void houseKeeping()
-
-Subclass hook for activities such as rolling files and cleaning up old garbage. Called during
- periods of inactivity or after the houseKeepingInterval is exceeded. Does nothing by default
- and flush will be called just prior to this.
-
-Overrides: houseKeeping AsyncLogHandler
-
-
-
-
-
-
-
-makeBackup
-public void makeBackup()
-Only public for testing, do not call. Zips the current logging file, deletes the unzipped
- version, then starts a new one.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- PrintStreamLogHandler (dslink-core 0.19.0 API)
-PrintStreamLogHandler (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.util.logging.Handler
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-PrintStreamLogHandler
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-Methods inherited from class java.util.logging.Handler
-getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
org.iot.dsa.logging (dslink-core 0.19.0 API)
-org.iot.dsa.logging (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
org.iot.dsa.logging (dslink-core 0.19.0 API)
-org.iot.dsa.logging (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-DSILevels
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-AsyncLogHandler
-Enqueues logging records which are then processed by separate thread.
-
-
-
-DSLogger
-Adds an abstraction layer on Java Util Logging for two purposes:
-
-
-
- To use the DSA levels.
-
-
-
-DSLogging
-Static utilities for configuring the logging subsystem.
-
-
-
-FileLogHandler
-Logs records to a file.
-
-
-
-PrintStreamLogHandler
-Async logging handler for writing to streams such as System.out.
-
-
-
-
-
-
-
-
-
-
Package org.iot.dsa.logging Description
-
Async handler for Java Util Logging that also manages log backups.
-
org.iot.dsa.logging Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.logging Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-java.lang.Object
-
-org.iot.dsa.logging.DSLogger DSILevels )
-org.iot.dsa.logging.DSLogging
-java.util.logging.Handler
-
-
-
-
-
-
Interface Hierarchy
-
-
DSBool (dslink-core 0.19.0 API)
-DSBool (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-copy , isBytes , isDouble , isEqual , isFloat , isGroup , isInt , isList , isLong , isMap , isNumber , isString , make , make , make , make , make , make , makeNull , toBytes , toElement , toGroup , toList , toMap
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-toBoolean
-public boolean toBoolean()
-
-Attempts to return a boolean value. Numerics will return false for 0 and true for anything
- else. Strings should return true for "true" or "1" and false for "false" or "0". Anything
- else will throws a ClassCastException.
-
-Specified by: toBoolean DSIBoolean Overrides: toBoolean DSElement
-
-
-
-
-
-
-
-toDouble
-public double toDouble()
-0 or 1.
-
-Overrides: toDouble DSElement
-
-
-
-
-
-
-
-toFloat
-public float toFloat()
-0 or 1.
-
-Overrides: toFloat DSElement
-
-
-
-
-
-
-
-toInt
-public int toInt()
-0 or 1.
-
-Overrides: toInt DSElement
-
-
-
-
-
-
-
-toLong
-public long toLong()
-0 or 1.
-
-Overrides: toLong DSElement
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSBytes (dslink-core 0.19.0 API)
-DSBytes (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSBytes NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static byte[]decode
-
-static java.lang.Stringencode
-
-booleanequals True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
-static byte[]fromHex Converts a hex string into a byte array.
-
-
-byte[]getBytes The raw bytes, do not modify.
-
-
-DSElementType getElementType For switch statements.
-
-
-DSValueType getValueType The DSA value type mapping.
-
-
-inthashCode
-
-booleanisBytes Whether or not the object represents a byte array.
-
-
-static booleanisBytes True if the string starts with the DSA escape sequence for a base 64 encoded string.
-
-
-booleanisNull Whether or not the object represents null.
-
-
-intlength The number of bytes in the array.
-
-
-static doublereadDouble Reads the primitive from a byte array.
-
-
-static doublereadDouble Reads the primitive from a stream.
-
-
-static floatreadFloat Reads the primitive from a byte array.
-
-
-static floatreadFloat Reads the primitive a stream
-
-
-static intreadInt Reads the primitive from a byte array.
-
-
-static intreadInt Reads the primitive from a stream.
-
-
-static longreadLong Reads the primitive from a byte array.
-
-
-static longreadLong Reads the primitive from a stream.
-
-
-static shortreadShort Reads the primitive from a byte array.
-
-
-static shortreadShort Reads the primitive from a stream.
-
-
-byte[]toBytes Returns the raw byte array for DSBytes only, which should not be modified.
-
-
-static java.lang.StringBuildertoHex Converts the bytes into a hex string.
-
-
-static java.lang.StringBuildertoHex Converts the bytes into a hex string.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-static DSBytes valueOf
-
-DSBytes valueOf DSElement arg)Returns the argument.
-
-
-static DSBytes valueOf Decodes a base64 encoded byte array.
-
-
-static voidwriteDouble Encodes the primitive into a byte array.
-
-
-static voidwriteDouble Encodes the primitive into a stream.
-
-
-static voidwriteFloat Encodes the primitive into a byte array.
-
-
-static voidwriteFloat Encodes the primitive into a stream
-
-
-static voidwriteInt Encodes the primitive into a byte array.
-
-
-static voidwriteInt Encodes the primitive into a stream.
-
-
-static voidwriteLong Encodes the primitive into a byte array.
-
-
-static voidwriteLong Encodes the primitive into a stream.
-
-
-static voidwriteShort Encodes the primitive into a byte array.
-
-
-static voidwriteShort Encodes the primitive into a stream.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-copy , isBoolean , isDouble , isEqual , isFloat , isGroup , isInt , isList , isLong , isMap , isNumber , isString , make , make , make , make , make , make , makeNull , toBoolean , toDouble , toElement , toFloat , toGroup , toInt , toList , toLong , toMap
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-readDouble
-public static double readDouble(byte[] buf,
- int off,
- boolean bigEndian)
-Reads the primitive from a byte array.
-
-Parameters: buf - Must be at least off + 8 in length.off - The offset into the buffer to start reading.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readDouble
-public static double readDouble(java.io.InputStream in,
- boolean bigEndian)
-Reads the primitive from a stream.
-
-Parameters: in - Must have at 8 bytes to read.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readFloat
-public static float readFloat(byte[] buf,
- int off,
- boolean bigEndian)
-Reads the primitive from a byte array.
-
-Parameters: buf - Must be at least off + 4 in length.off - The offset into the buffer to start reading.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readFloat
-public static float readFloat(java.io.InputStream in,
- boolean bigEndian)
-Reads the primitive a stream
-
-Parameters: in - Must have at 4 bytes to read.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readInt
-public static int readInt(byte[] buf,
- int off,
- boolean bigEndian)
-Reads the primitive from a byte array.
-
-Parameters: buf - Must be at least off + 4 in length.off - The offset into the buffer to start reading.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readInt
-public static int readInt(java.io.InputStream in,
- boolean bigEndian)
-Reads the primitive from a stream.
-
-Parameters: in - Must have at least 4 bytes to read.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readLong
-public static long readLong(byte[] buf,
- int off,
- boolean bigEndian)
-Reads the primitive from a byte array.
-
-Parameters: buf - Must be at least off + 8 in length.off - The offset into the buffer to start reading.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readLong
-public static long readLong(java.io.InputStream in,
- boolean bigEndian)
-Reads the primitive from a stream.
-
-Parameters: in - Must have 8 bytes to read.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readShort
-public static short readShort(byte[] buf,
- int off,
- boolean bigEndian)
-Reads the primitive from a byte array.
-
-Parameters: buf - Must be at least off + 2 in length.off - The offset into the buffer to start reading.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-readShort
-public static short readShort(java.io.InputStream in,
- boolean bigEndian)
-Reads the primitive from a stream.
-
-Parameters: in - Must have 2 bytes to read.bigEndian - Whether to decode in big or little endian byte ordering.
-
-
-
-
-
-
-
-
-
-
-
-toHex
-public static java.lang.StringBuilder toHex(byte val,
- java.lang.StringBuilder buf)
-Converts the bytes into a hex string.
-
-Parameters: val - What to convert.buf - Where to put the results, can be null.Returns: The buf parameter, or a new StringBuilder if the param was null.
-
-
-
-
-
-
-
-
-toHex
-public static java.lang.StringBuilder toHex(byte[] bytes,
- java.lang.StringBuilder buf)
-Converts the bytes into a hex string.
-
-Parameters: bytes - What to convert.buf - Where to put the results, can be null.Returns: The buf parameter, or a new StringBuilder if the param was null.
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-writeDouble
-public static void writeDouble(double v,
- byte[] buf,
- int off,
- boolean bigEndian)
-Encodes the primitive into a byte array.
-
-Parameters: v - The value to encode.buf - Where to encode the value. Must be at least off + 8 in length.off - The offset into the buffer to start encoding.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeDouble
-public static void writeDouble(double v,
- java.io.OutputStream out,
- boolean bigEndian)
-Encodes the primitive into a stream.
-
-Parameters: v - The value to encode.out - Where to encode the value.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeFloat
-public static void writeFloat(float v,
- byte[] buf,
- int off,
- boolean bigEndian)
-Encodes the primitive into a byte array.
-
-Parameters: v - The value to encode.buf - Where to encode the value. Must be at least off + 4 in length.off - The offset into the buffer to start encoding.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeFloat
-public static void writeFloat(float v,
- java.io.OutputStream out,
- boolean bigEndian)
-Encodes the primitive into a stream
-
-Parameters: v - The value to encode.out - Where to encode the value.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeInt
-public static void writeInt(int v,
- byte[] buf,
- int off,
- boolean bigEndian)
-Encodes the primitive into a byte array.
-
-Parameters: v - The value to encode.buf - Where to encode the value. Must be at least off + 4 in length.off - The offset into the buffer to start encoding.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeInt
-public static void writeInt(int v,
- java.io.OutputStream out,
- boolean bigEndian)
-Encodes the primitive into a stream.
-
-Parameters: v - The value to encode.out - Where to encode the value.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeLong
-public static void writeLong(long v,
- byte[] buf,
- int off,
- boolean bigEndian)
-Encodes the primitive into a byte array.
-
-Parameters: v - The value to encode.buf - Where to encode the value. Must be at least off + 8 in length;off - The offset into the buffer to start encoding.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeLong
-public static void writeLong(long v,
- java.io.OutputStream out,
- boolean bigEndian)
-Encodes the primitive into a stream.
-
-Parameters: v - The value to encode.out - Where to encode the value.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeShort
-public static void writeShort(short v,
- byte[] buf,
- int off,
- boolean bigEndian)
-Encodes the primitive into a byte array.
-
-Parameters: v - The value to encode.buf - Where to encode the value. Must be a least off + 2 in length.off - The offset into the buffer to start encoding.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
-writeShort
-public static void writeShort(short v,
- java.io.OutputStream out,
- boolean bigEndian)
-Encodes the primitive into a stream.
-
-Parameters: v - The value to encode.out - Where to encode the value.bigEndian - Whether to encode in big or little endian byte ordering.
-
-
-
-
-
-
-
DSDouble (dslink-core 0.19.0 API)
-DSDouble (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSDouble NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-booleanequals True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
-DSElementType getElementType For switch statements.
-
-
-DSValueType getValueType The DSA value type mapping.
-
-
-inthashCode
-
-booleanisDouble Whether or not the object represents a double.
-
-
-booleanisInfinite
-
-booleanisNaN
-
-booleanisNull Whether or not the object represents null.
-
-
-booleanisNumber Whether or not the object represents a number.
-
-
-booleantoBoolean Attempts to return a boolean value.
-
-
-doubletoDouble Attempts to return a double value.
-
-
-floattoFloat Attempts to return a float value.
-
-
-inttoInt Attempts to return an int value.
-
-
-longtoLong Attempts to return a long value.
-
-
-java.lang.NumbertoNumber Returns the Java primitive wrapper.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-static DSDouble valueOf Attempts to reuse some common values before creating a new instance.
-
-
-DSDouble valueOf DSElement arg)Returns the argument.
-
-
-static DSDouble valueOf Checks for null, then uses Double.parseDouble()
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-copy , isBoolean , isBytes , isEqual , isFloat , isGroup , isInt , isList , isLong , isMap , isString , make , make , make , make , make , make , makeNull , toBytes , toElement , toGroup , toList , toMap
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isNaN
-public boolean isNaN()
-
-See Also: Double.isNaN()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toBoolean
-public boolean toBoolean()
-
-Attempts to return a boolean value. Numerics will return false for 0 and true for anything
- else. Strings should return true for "true" or "1" and false for "false" or "0". Anything
- else will throws a ClassCastException.
-
-Overrides: toBoolean DSElement
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSElement (dslink-core 0.19.0 API)
-DSElement (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSElement
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSElement copy If an object is mutable (list or map) then this should clone it, immutable objects can simply
- return themselves.
-
-
-abstract DSElementType getElementType For switch statements.
-
-
-abstract DSValueType getValueType The DSA value type mapping.
-
-
-booleanisBoolean Whether or not the object represents a boolean.
-
-
-booleanisBytes Whether or not the object represents a byte array.
-
-
-booleanisDouble Whether or not the object represents a double.
-
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisFloat Whether or not the object represents a float.
-
-
-booleanisGroup Whether or not the object represents a list or map.
-
-
-booleanisInt Whether or not the object represents an int.
-
-
-booleanisList Whether or not the object represents a list.
-
-
-booleanisLong Whether or not the object represents a long.
-
-
-booleanisMap Whether or not the object represents a amp.
-
-
-booleanisNull Whether or not the object represents null.
-
-
-booleanisNumber Whether or not the object represents a number.
-
-
-booleanisString Whether or not the object represents a string.
-
-
-static DSElement make Creates an DSIObject representation of the primitive.
-
-
-static DSElement make Creates an DSIObject representation of the primitive.
-
-
-static DSElement make Creates an DSIObject representation of the primitive.
-
-
-static DSElement make Creates an DSIObject representation of the primitive.
-
-
-static DSElement make Creates an DSIObject representation of the primitive.
-
-
-static DSElement make Creates an DSIObject representation of the primitive.
-
-
-static DSElement makeNull Creates an DSIObject representation of null.
-
-
-booleantoBoolean Attempts to return a boolean value.
-
-
-byte[]toBytes Returns the raw byte array for DSBytes only, which should not be modified.
-
-
-doubletoDouble Attempts to return a double value.
-
-
-DSElement toElement Returns this.
-
-
-floattoFloat Attempts to return a float value.
-
-
-DSGroup toGroup Lists and maps return themselves, everything else results in an exception.
-
-
-inttoInt Attempts to return an int value.
-
-
-DSList toList Lists return themselves, everything else results in an exception.
-
-
-longtoLong Attempts to return a long value.
-
-
-DSMap toMap Maps return themselves, everything else results in an exception.
-
-
-DSIValue valueOf DSElement arg)Returns the argument.
-
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSElement
-public DSElement()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toBoolean
-public boolean toBoolean()
-Attempts to return a boolean value. Numerics will return false for 0 and true for anything
- else. Strings should return true for "true" or "1" and false for "false" or "0". Anything
- else will throws a ClassCastException.
-
-Throws: java.lang.ClassCastException - If not convertible.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSElementType (dslink-core 0.19.0 API)
-DSElementType (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Enum<DSElementType >
-
-
-org.iot.dsa.node.DSElementType
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static DSElementType valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
-
-
-
-
DSFlexEnum (dslink-core 0.19.0 API)
-DSFlexEnum (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSFlexEnum NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSFlexEnum copy Returns this.
-
-
-booleanequals True if the argument is a DSFlexEnum and the values are equal or they are both isNull.
-
-
-DSList getEnums DSList bucket)Adds the range of possible values to the given bucket.
-
-
-voidgetMetadata DSMap bucket)The entity should add any metadata about itself to the given map.
-
-
-DSValueType getValueType The DSA type mapping.
-
-
-inthashCode
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-DSFlexEnum restore DSElement arg)Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-
-DSMap store Serialize the value for the configuration database.
-
-
-DSElement toElement The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-DSFlexEnum valueOf DSElement arg)This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-
-DSFlexEnum valueOf Creates a new enum for the given value using the range from this instance.
-
-
-static DSFlexEnum valueOf DSList range)Creates a enum representing the given value and range.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getMetadata
-public void getMetadata(DSMap bucket)
-
-The entity should add any metadata about itself to the given map. DSIMetadata instances will
- first populate the bucket, then parent nodes will be given a chance the modify the bucket via
- DSNode.getMetadata(DSInfo,DSMap).
-
-Specified by: getMetadata DSIMetadata
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-restore
-public DSFlexEnum restore(DSElement arg)
-
-Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-Specified by: restore DSIStorable
-
-
-
-
-
-
-
-
-
-
-
-toElement
-public DSElement toElement()
-Description copied from interface: DSIValue The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests. This is not for configuration database serialization.
-
-Specified by: toElement DSIValue
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Specified by: toString DSIEnum Overrides: toString DSValue
-
-
-
-
-
-
-
-valueOf
-public DSFlexEnum valueOf(DSElement arg)
-Description copied from interface: DSIValue This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-Specified by: valueOf DSIValue
-
-
-
-
-
-
-
-valueOf
-public static DSFlexEnum valueOf(java.lang.String value,
- DSList range)
-Creates a enum representing the given value and range.
-
-Parameters: value - Must be in the given range.range - The all possible values in the range, must include the value param.
-
-
-
-
-
-
-
-
-
-
-
DSFloat (dslink-core 0.19.0 API)
-DSFloat (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-All Implemented Interfaces:
-DSINumber , DSIObject , DSIValue
-public class DSFloat
-extends DSValue
-implements DSINumber
-A Java float. Try not to use, floats can only be converted to doubles by first converting them
- to strings.
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSFloat NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-booleanequals True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
-DSValueType getValueType The DSA type mapping.
-
-
-inthashCode
-
-booleanisDouble Whether or not the object represents a double.
-
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisFloat Whether or not the object represents a double.
-
-
-booleanisInt Whether or not the object represents an int.
-
-
-booleanisLong Whether or not the object represents a long.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-doubletoDouble If not a double, will cast the underlying value.
-
-
-DSElement toElement The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-
-floattoFloat If not a float, will cast the underlying value.
-
-
-inttoInt If not an int, will cast the underlying value.
-
-
-longtoLong If not a long, will cast the underlying value.
-
-
-java.lang.NumbertoNumber Returns the Java primitive wrapper.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-DSFloat valueOf DSElement arg)This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-
-static DSFloat valueOf Attempts to reuse some common values before creating a new instance.
-
-
-static DSFloat valueOf Checks for null, then uses Float.parseFloat()
-
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toElement
-public DSElement toElement()
-Description copied from interface: DSIValue The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests. This is not for configuration database serialization.
-
-Specified by: toElement DSIValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-valueOf
-public DSFloat valueOf(DSElement arg)
-Description copied from interface: DSIValue This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-Specified by: valueOf DSIValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSGroup (dslink-core 0.19.0 API)
-DSGroup (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSGroup
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-abstract DSGroup clear Removes all items.
-
-
-booleanequals
-
-DSElement first Returns the item at index 0.
-
-
-abstract DSElement get Returns the value at the given index.
-
-
-booleanget Optional getter.
-
-
-doubleget Optional getter.
-
-
-intget Optional getter.
-
-
-longget Optional getter.
-
-
-java.lang.Stringget Optional getter.
-
-
-booleangetBoolean Primitive getter.
-
-
-doublegetDouble Primitive getter.
-
-
-doublegetFloat Primitive getter.
-
-
-intgetInt Primitive getter.
-
-
-DSList getList Primitive getter.
-
-
-longgetLong Primitive getter.
-
-
-DSMap getMap Primitive getter.
-
-
-java.lang.StringgetString Primitive getter.
-
-
-inthashCode
-
-booleanhasParent
-
-intindexOf DSElement obj)Scans the collection and returns the first index that equal the arg.
-
-
-booleanisEmpty Returns true when childCount() == 0.
-
-
-booleanisGroup Whether or not the object represents a list or map.
-
-
-booleanisNull Whether or not the object at the given index is null.
-
-
-DSElement last Returns the item at the highest index.
-
-
-intlastIndexOf DSElement obj)Scans the collection and returns the first index that equal the arg.
-
-
-abstract DSElement remove Removes the value at the given index and returns it.
-
-
-DSElement removeFirst Remove and return the item at index 0.
-
-
-DSElement removeLast Remove and return the item at the highest index.
-
-
-abstract intsize The number of items is the group.
-
-
-DSGroup toGroup Lists and maps return themselves, everything else results in an exception.
-
-
-java.lang.StringtoString Json encodes the graph, be careful.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-copy , getElementType , getValueType , isBoolean , isBytes , isDouble , isEqual , isFloat , isInt , isList , isLong , isMap , isNull , isNumber , isString , make , make , make , make , make , make , makeNull , toBoolean , toBytes , toDouble , toElement , toFloat , toInt , toList , toLong , toMap , valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSGroup
-public DSGroup()
-
-
-
-
-
-
-
-
-
DSIBoolean (dslink-core 0.19.0 API)
-DSIBoolean (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-toBoolean
-boolean toBoolean()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIEnum (dslink-core 0.19.0 API)
-DSIEnum (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-All Known Implementing Classes:
-DSFlexEnum , DSJavaEnum
-public interface DSIEnum
-DSA Enum mapping.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIMetadata (dslink-core 0.19.0 API)
-DSIMetadata (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getMetadata
-void getMetadata(DSMap bucket)
-The entity should add any metadata about itself to the given map. DSIMetadata instances will
- first populate the bucket, then parent nodes will be given a chance the modify the bucket via
- DSNode.getMetadata(DSInfo,DSMap).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSINumber (dslink-core 0.19.0 API)
-DSINumber (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-booleanisDouble Whether or not the object represents a double.
-
-
-booleanisFloat Whether or not the object represents a double.
-
-
-booleanisInt Whether or not the object represents an int.
-
-
-booleanisLong Whether or not the object represents a long.
-
-
-doubletoDouble If not a double, will cast the underlying value.
-
-
-floattoFloat If not a float, will cast the underlying value.
-
-
-inttoInt If not an int, will cast the underlying value.
-
-
-longtoLong If not a long, will cast the underlying value.
-
-
-java.lang.NumbertoNumber Returns the Java primitive wrapper.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIObject (dslink-core 0.19.0 API)
-DSIObject (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-DSIObject copy Return a copy if it makes sense, but return this otherwise.
-
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisNull
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-isEqual
-boolean isEqual(java.lang.Object obj)
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-
-
-
-
-
-isNull
-boolean isNull()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIStatus (dslink-core 0.19.0 API)
-DSIStatus (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIStorable (dslink-core 0.19.0 API)
-DSIStorable (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-restore
-DSIValue restore(DSElement element)Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSIValue (dslink-core 0.19.0 API)
-DSIValue (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-DSValueType getValueType The DSA type mapping.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-DSElement toElement The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-
-DSIValue valueOf DSElement element)This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-valueOf
-DSIValue valueOf(DSElement element)This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSInfo (dslink-core 0.19.0 API)
-DSInfo (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.DSInfo
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-copy
-public DSInfo copy()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getChildren
-public java.util.Iterator<ApiObject > getChildren()
-
-Iterator of child objects, should only be called if hasChildren() returns true.
-
-Specified by: getChildren ApiObject
-
-
-
-
-
-
-
-getDefaultObject
-public DSIObject getDefaultObject()
-If this represents a dynamic child, this just returns the current value.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(DSInfo arg)
-True if the flags and target object are equal (not identical if the target is a node). Two
- nodes are considered equal if they have the same children, although they may be ordered
- differently.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSInt (dslink-core 0.19.0 API)
-DSInt (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSInt NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-booleanequals True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
-DSValueType getValueType The DSA type mapping.
-
-
-inthashCode
-
-booleanisDouble Whether or not the object represents a double.
-
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisFloat Whether or not the object represents a double.
-
-
-booleanisInt Whether or not the object represents an int.
-
-
-booleanisLong Whether or not the object represents a long.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-doubletoDouble If not a double, will cast the underlying value.
-
-
-DSElement toElement The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-
-floattoFloat If not a float, will cast the underlying value.
-
-
-inttoInt If not an int, will cast the underlying value.
-
-
-longtoLong If not a long, will cast the underlying value.
-
-
-java.lang.NumbertoNumber Returns the Java primitive wrapper.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-DSInt valueOf DSElement arg)This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-
-static DSInt valueOf Attempts to reuse some common values before creating a new instance.
-
-
-static DSInt valueOf Checks for null, then uses Float.parseFloat()
-
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toElement
-public DSElement toElement()
-Description copied from interface: DSIValue The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests. This is not for configuration database serialization.
-
-Specified by: toElement DSIValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-valueOf
-public DSInt valueOf(DSElement arg)
-Description copied from interface: DSIValue This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-Specified by: valueOf DSIValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSJavaEnum (dslink-core 0.19.0 API)
-DSJavaEnum (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSJavaEnum NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-booleanequals True if the argument is a DSDynamicEnum and the values are equal or they are both isNull.
-
-
-DSList getEnums DSList bucket)Adds the range of possible values to the given bucket.
-
-
-voidgetMetadata DSMap bucket)The entity should add any metadata about itself to the given map.
-
-
-DSValueType getValueType The DSA type mapping.
-
-
-inthashCode
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-DSJavaEnum restore DSElement arg)Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-
-DSElement store Serialize the value for the configuration database.
-
-
-DSElement toElement The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-
-java.lang.EnumtoEnum The Java enum.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-DSJavaEnum valueOf DSElement arg)This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-
-static DSJavaEnum valueOf Creates an enum for the given value (and it's range).
-
-
-DSJavaEnum valueOf
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-getMetadata
-public void getMetadata(DSMap bucket)
-
-The entity should add any metadata about itself to the given map. DSIMetadata instances will
- first populate the bucket, then parent nodes will be given a chance the modify the bucket via
- DSNode.getMetadata(DSInfo,DSMap).
-
-Specified by: getMetadata DSIMetadata
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-restore
-public DSJavaEnum restore(DSElement arg)
-
-Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-Specified by: restore DSIStorable
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toElement
-public DSElement toElement()
-Description copied from interface: DSIValue The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests. This is not for configuration database serialization.
-
-Specified by: toElement DSIValue
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Specified by: toString DSIEnum Overrides: toString DSValue
-
-
-
-
-
-
-
-valueOf
-public DSJavaEnum valueOf(DSElement arg)
-Description copied from interface: DSIValue This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-Specified by: valueOf DSIValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSList (dslink-core 0.19.0 API)
-DSList (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-protected java.util.ArrayListlist
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSList
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSList add Appends the primitive and returns this.
-
-
-DSList add Appends the primitive and returns this.
-
-
-DSList add DSElement val)Adds the value and returns this.
-
-
-DSList add Appends the primitive and returns this.
-
-
-DSList add Appends the primitive and returns this.
-
-
-DSList add Appends the primitive and returns this.
-
-
-DSList addAll DSList list)Add all elements of the argument to this list and returns this.
-
-
-DSList addList Appends a new list and returns it.
-
-
-DSMap addMap Appends a new map and returns it.
-
-
-DSList addNull Appends null and returns this.
-
-
-DSList clear Removes all items.
-
-
-booleancontains DSElement value)
-
-DSList copy If an object is mutable (list or map) then this should clone it, immutable objects can simply
- return themselves.
-
-
-DSElement get Returns the value at the given index.
-
-
-DSElementType getElementType For switch statements.
-
-
-DSValueType getValueType The DSA value type mapping.
-
-
-booleanisList Returns true.
-
-
-booleanisNull Returns false.
-
-
-java.util.Iterator<DSElement >iterator Returns an iterator that does not implement remove.
-
-
-DSList put Primitive setter, returns this.
-
-
-DSList put Primitive setter, returns this.
-
-
-DSList put DSElement val)Replaces a value and returns this.
-
-
-DSList put Primitive setter, returns this.
-
-
-DSList put Primitive setter, returns this.
-
-
-DSList put Primitive setter, returns this.
-
-
-DSElement remove Removes the value at the given index and returns it.
-
-
-intsize The number of items is the group.
-
-
-DSList toElement Returns this.
-
-
-DSList toList Lists return themselves, everything else results in an exception.
-
-
-static DSList valueOf
-
-static DSList valueOf DSElement ... values)
-
-DSList valueOf DSElement element)Returns the argument.
-
-
-static DSList valueOf
-
-static DSList valueOf
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSGroup
-equals , first , get , get , get , get , get , getBoolean , getDouble , getFloat , getInt , getList , getLong , getMap , getString , hashCode , hasParent , indexOf , isEmpty , isGroup , isNull , last , lastIndexOf , removeFirst , removeLast , toGroup , toString
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-isBoolean , isBytes , isDouble , isEqual , isFloat , isInt , isLong , isMap , isNumber , isString , make , make , make , make , make , make , makeNull , toBoolean , toBytes , toDouble , toFloat , toInt , toLong , toMap
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.lang.Iterable
-forEach, spliterator
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSList
-public DSList()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-clear
-public DSList clear()
-Description copied from class: DSGroup Removes all items.
-
-Specified by: clear DSGroup Returns: This
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isList
-public boolean isList()
-Returns true.
-
-Overrides: isList DSElement
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-put
-public DSList put(int idx,
- boolean val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSList put(int idx,
- double val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSList put(int idx,
- int val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSList put(int idx,
- long val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSList put(int idx,
- java.lang.String val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSLong (dslink-core 0.19.0 API)
-DSLong (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSLong NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-booleanequals True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
-DSElementType getElementType For switch statements.
-
-
-DSValueType getValueType The DSA value type mapping.
-
-
-inthashCode
-
-booleanisLong Whether or not the object represents a long.
-
-
-booleanisNull Whether or not the object represents null.
-
-
-booleanisNumber Whether or not the object represents a number.
-
-
-booleantoBoolean Attempts to return a boolean value.
-
-
-doubletoDouble Attempts to return a double value.
-
-
-floattoFloat Attempts to return a float value.
-
-
-inttoInt Attempts to return an int value.
-
-
-longtoLong Attempts to return a long value.
-
-
-java.lang.NumbertoNumber Returns the Java primitive wrapper.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-DSLong valueOf DSElement arg)Returns this.
-
-
-static DSLong valueOf Attempts to reuse some common values before creating a new instance.
-
-
-static DSLong valueOf Checks for null, then uses Float.parseFloat()
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-copy , isBoolean , isBytes , isDouble , isEqual , isFloat , isGroup , isInt , isList , isMap , isString , make , make , make , make , make , make , makeNull , toBytes , toElement , toGroup , toList , toMap
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toBoolean
-public boolean toBoolean()
-
-Attempts to return a boolean value. Numerics will return false for 0 and true for anything
- else. Strings should return true for "true" or "1" and false for "false" or "0". Anything
- else will throws a ClassCastException.
-
-Overrides: toBoolean DSElement
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSMap.Entry (dslink-core 0.19.0 API)
-DSMap.Entry (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.DSMap.Entry
-
-
-
-
-
-
-
-Enclosing class:
-DSMap
-public static class DSMap.Entry
-extends java.lang.Object
-Allows values to be accessed quickly by index in the list, rather than having to do a key
- lookup in the map.
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSMap (dslink-core 0.19.0 API)
-DSMap (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Class and Description
-
-
-static class DSMap.Entry Allows values to be accessed quickly by index in the list, rather than having to do a key
- lookup in the map.
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-protected java.util.List<DSMap.Entry >keys For preserving order.
-
-
-protected java.util.Map<java.lang.String,DSMap.Entry >map
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSMap
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSMap clear Removes all items.
-
-
-booleancontains
-
-DSMap copy If an object is mutable (list or map) then this should clone it, immutable objects can simply
- return themselves.
-
-
-booleanequals
-
-DSElement get Returns the value at the given index.
-
-
-DSElement get Returns the value for the given key.
-
-
-booleanget Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-
-doubleget Optional getter, returns the provided default if the value mapped to the key is null.
-
-
-intget Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-
-longget Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-
-java.lang.Stringget Optional getter, returns the provided default if the value mapped to the key is null.
-
-
-booleangetBoolean Primitive getter.
-
-
-doublegetDouble Primitive getter.
-
-
-DSElementType getElementType For switch statements.
-
-
-DSMap.Entry getEntry
-
-DSMap.Entry getEntry
-
-intgetInt Primitive getter.
-
-
-java.lang.StringgetKey Returns the key at the given index.
-
-
-DSList getList Return the list, or null.
-
-
-longgetLong Primitive getter.
-
-
-DSMap getMap Returns the map value for the given key, or null.
-
-
-java.lang.StringgetString Returns the String value for the given key, or null.
-
-
-DSValueType getValueType The DSA value type mapping.
-
-
-inthashCode
-
-intindexOf Index of the given key, or -1.
-
-
-booleanisMap Returns true.
-
-
-booleanisNull Returns false.
-
-
-booleanisNull Returns true if the key isn't in the map, or it's value is null.
-
-
-DSMap put Primitive setter, returns this.
-
-
-DSMap put Primitive setter, returns this.
-
-
-DSMap put DSElement val)Adds or replaces the value for the given key and returns this.
-
-
-DSMap put Primitive setter, returns this.
-
-
-DSMap put Primitive setter, returns this.
-
-
-DSMap put Primitive setter, returns this.
-
-
-DSMap put Puts a String representing the stack trace into the map.
-
-
-DSMap putAll DSMap toAdd)Adds / overwrites entries in this map with those from the given.
-
-
-DSList putList Puts a new list for given key and returns it.
-
-
-DSMap putMap Puts a new map for given key and returns it.
-
-
-DSMap putNull Puts a null value for given key and returns this.
-
-
-DSElement remove Removes the value at the given index and returns it.
-
-
-DSElement remove Removes the key-value pair and returns the removed value.
-
-
-intsize The number of items is the group.
-
-
-DSMap toElement Returns this.
-
-
-DSMap toMap Maps return themselves, everything else results in an exception.
-
-
-DSMap valueOf DSElement element)Returns the argument.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSGroup
-first , get , get , get , get , get , getBoolean , getDouble , getFloat , getInt , getList , getLong , getMap , getString , hasParent , indexOf , isEmpty , isGroup , isNull , last , lastIndexOf , removeFirst , removeLast , toGroup , toString
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-isBoolean , isBytes , isDouble , isEqual , isFloat , isInt , isList , isLong , isNumber , isString , make , make , make , make , make , make , makeNull , toBoolean , toBytes , toDouble , toFloat , toInt , toList , toLong
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSMap
-public DSMap()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-clear
-public DSMap clear()
-Description copied from class: DSGroup Removes all items.
-
-Specified by: clear DSGroup Returns: This
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-get
-public boolean get(java.lang.String key,
- boolean def)
-Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-
-
-
-
-
-
-get
-public double get(java.lang.String key,
- double def)
-Optional getter, returns the provided default if the value mapped to the key is null.
-
-
-
-
-
-
-
-get
-public int get(java.lang.String key,
- int def)
-Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-
-
-
-
-
-
-get
-public long get(java.lang.String key,
- long def)
-Optional getter, returns the provided default if the value mapped to the key is null or not
- convertible.
-
-
-
-
-
-
-
-get
-public java.lang.String get(java.lang.String key,
- java.lang.String def)
-Optional getter, returns the provided default if the value mapped to the key is null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getString
-public java.lang.String getString(java.lang.String key)
-Returns the String value for the given key, or null.
-
-Returns: Possibly null.
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode DSGroup
-
-
-
-
-
-
-
-isMap
-public boolean isMap()
-Returns true.
-
-Overrides: isMap DSElement
-
-
-
-
-
-
-
-
-
-
-
-isNull
-public boolean isNull(java.lang.String key)
-Returns true if the key isn't in the map, or it's value is null.
-
-
-
-
-
-
-
-
-
-
-
-put
-public DSMap put(java.lang.String key,
- DSElement val)
-Adds or replaces the value for the given key and returns this.
-
-Parameters: key - Must not be null.val - Can be null, and can not be an already parented group.Returns: this
-
-
-
-
-
-
-
-
-put
-public DSMap put(java.lang.String key,
- boolean val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSMap put(java.lang.String key,
- double val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSMap put(java.lang.String key,
- int val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSMap put(java.lang.String key,
- long val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSMap put(java.lang.String key,
- java.lang.String val)
-Primitive setter, returns this.
-
-
-
-
-
-
-
-put
-public DSMap put(java.lang.String key,
- java.lang.Throwable val)
-Puts a String representing the stack trace into the map.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSMetadata (dslink-core 0.19.0 API)
-DSMetadata (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.DSMetadata
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static java.lang.StringBOOLEAN_RANGE
-
-static java.lang.StringDECIMAL_PLACES
-
-static java.lang.StringDEFAULT
-
-static java.lang.StringDESCRIPTION
-
-static java.lang.StringDISPLAY_NAME
-
-static java.lang.StringEDITOR
-
-static java.lang.StringENUM_RANGE
-
-static java.lang.StringMAX_VALUE
-
-static java.lang.StringMIN_VALUE
-
-static java.lang.StringNAME
-
-static java.lang.StringPLACEHOLDER
-
-static java.lang.StringTYPE
-
-static java.lang.StringUNIT
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSMetadata clear
-
-DSMetadata clear
-
-DSList getBooleanRange The boolean range, or null.
-
-
-DSLong getDecimalPlaces The decimal precision or null.
-
-
-DSElement getDefault The default value for an action parameter, or null.
-
-
-java.lang.StringgetDescription The description, or null.
-
-
-java.lang.StringgetDisplayName The alternate display name, or null.
-
-
-java.lang.StringgetEditor The editor, or null.
-
-
-DSList getEnumRange The editor, or null.
-
-
-DSMap getMap
-
-DSElement getMaxValue The max value, or null.
-
-
-static DSMap getMetadata DSInfo info,
- DSMap bucket)Fully acquires metadata about the info.
-
-
-DSElement getMinValue The min value, or null.
-
-
-java.lang.StringgetName The name, or null.
-
-
-java.lang.StringgetPlaceHolder Placeholder text for text fields, or null.
-
-
-java.lang.StringgetType The type for action parameters, can be used to override types in the responder api.
-
-
-java.lang.StringgetUnit Value if defined, otherwise null.
-
-
-booleanisEmpty
-
-DSMetadata set DSElement value)Set arbitrary keys.
-
-
-DSMetadata setBooleanRange DSList range)The list must be size 2 and the entries must not be null.
-
-
-DSMetadata setBooleanRange The parameters can be null, which will result in the default text (false/true).
-
-
-DSMetadata setDecimalPlaces DSLong arg)
-
-DSMetadata setDefault DSIValue arg)Sets the default value only, does not set type information.
-
-
-DSMetadata setDescription
-
-DSMetadata setDisplayName
-
-DSMetadata setEditor See the EDITOR_ constants.
-
-
-DSMetadata setEnumRange DSList arg)List of string values for an enum or string.
-
-
-DSMetadata setEnumRange List of string values for an enum or string.
-
-
-DSMetadata setMap DSMap arg)Change the underlying map so the metadata instance can be reused.
-
-
-DSMetadata setMaxValue DSElement arg)The arg should be a number.
-
-
-DSMetadata setMinValue DSElement arg)The arg should be a number.
-
-
-DSMetadata setName
-
-DSMetadata setPlaceHolder Place holder text for text fields.
-
-
-DSMetadata setType DSIValue arg)Sets the type and if the given is an enum, sets the enum range as well.
-
-
-DSMetadata setType DSValueType arg)The type for action parameters, can be used to override types in the responder api.
-
-
-DSMetadata setUnit The unit identifier.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSMetadata
-public DSMetadata()
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-getMap
-public DSMap getMap()
-
-
-
-
-
-
-
-getBooleanRange
-public DSList getBooleanRange()
-The boolean range, or null. If not null, the length will be 2, index 0 will be the false
- text and index 1 the true text.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getMetadata
-public static DSMap getMetadata(DSInfo info,
- DSMap bucket)
-Fully acquires metadata about the info. If the target of the info implements DSIMetadata,
- it is put in the bucket first. Then if the parent node is allowed is given the the chance
- to add/edit the bucket.
-
-Parameters: info - Who to get metadata for.bucket - Where to put the metadata, can be null in which case a new map will be
- instantiated.Returns: The bucket arg, or a new map if the arg was null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getType
-public java.lang.String getType()
-The type for action parameters, can be used to override types in the responder api.
-
-
-
-
-
-
-
-
-
-
-
-isEmpty
-public boolean isEmpty()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-setBooleanRange
-public DSMetadata setBooleanRange(java.lang.String falseText,
- java.lang.String trueText)
-The parameters can be null, which will result in the default text (false/true).
-
-
-
-
-
-
-
-setDefault
-public DSMetadata setDefault(DSIValue arg)
-Sets the default value only, does not set type information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-setType
-public DSMetadata setType(DSIValue arg)
-Sets the type and if the given is an enum, sets the enum range as well.
-
-
-
-
-
-
-
-setType
-public DSMetadata setType(DSValueType arg)
-The type for action parameters, can be used to override types in the responder api.
-
-
-
-
-
-
-
-
-
-
-
DSNode (dslink-core 0.19.0 API)
-DSNode (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSNode
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSInfo add DSIObject object)Adds the named child only if the name is not already in use.
-
-
-intchildCount The number of children.
-
-
-DSNode clear Removes non-permanent children.
-
-
-booleancontains Whether or not this node has a child with the given name.
-
-
-DSNode copy Returns a clone of this node and its subtree.
-
-
-protected DSInfo declareDefault DSIObject value)Use this in the declareDefaults method to create a non-removable child.
-
-
-protected voiddeclareDefaults The is only called once for each class.
-
-
-protected voidfire DSTopic topic,
- DSIEvent event,
- DSInfo child)Notifies subscribers of the event.
-
-
-protected voidfire DSTopic topic,
- DSIEvent event,
- DSInfo child,
- java.lang.Object... params)Notifies subscribers of the event.
-
-
-DSIObject get Returns the child value with the given name, or null.
-
-
-DSElement getElement A convenience for (DSElement) get(name).
-
-
-DSIObject getFirst The first child, or null.
-
-
-DSInfo getFirstInfo The first child info, or null.
-
-
-DSInfo getFirstNodeInfo The info for the first child node, or null.
-
-
-DSInfo getInfo DSInfo for this node in its parent, or null if un-parented.
-
-
-DSInfo getInfo Returns the info for the child with the given name, or null.
-
-
-DSIObject getLast The last child, or null.
-
-
-DSInfo getLastInfo The last child info, or null.
-
-
-protected java.lang.StringgetLogName Override point, returns the simple class name by default.
-
-
-voidgetMetadata DSInfo info,
- DSMap bucket)Override point, add any meta data for the given info to the provided bucket.
-
-
-java.lang.StringgetName Returns the name of this node in its parent, or null if un-parented.
-
-
-DSNode getNode A convenience for (DSNode) get(name).
-
-
-DSNode getParent Returns the parent node, or null.
-
-
-java.lang.StringgetPath The DSA path, properly encoded.
-
-
-DSIValue getValue A convenience for (DSIValue) get(name).
-
-
-protected booleanisDefaultInstance True if this is the default instance for the type.
-
-
-booleanisEqual True if the argument is a node with the same children, although their order can be
- different.
-
-
-booleanisIdentical True if the argument is a node with the same children in the exact same order.
-
-
-protected static booleanisNode Convenience for instanceof DSNode.
-
-
-booleanisNull Returns false.
-
-
-booleanisRunning A convenience for !isStopped().
-
-
-booleanisStable True after stable is called, children are stable before their parents.
-
-
-booleanisStarted True after start is called, children are started before their parents.
-
-
-booleanisStopped True after stop is called, children are stopped before their parents.
-
-
-booleanisSubscribed True if there are any subscribers.
-
-
-booleanisSubscribed DSInfo child,
- DSTopic topic)True if there are any subscriptions with the matching child and topic.
-
-
-booleanisSubscribed DSTopic topic)True if there any subscriptions for the given topic.
-
-
-java.util.Iterator<DSInfo >iterateNodes Returns an info iterator of child DSNodes.
-
-
-java.util.Iterator<DSInfo >iterateValues Returns an info iterator of child DSIValues.
-
-
-java.util.Iterator<DSInfo >iterator Returns an info iterator of all children.
-
-
-protected voidonChildAdded DSInfo info)Called when the given child is added and in the stable state.
-
-
-protected voidonChildChanged DSInfo info)Called when the given child is changed and in the stable state.
-
-
-protected voidonChildRemoved DSInfo info)Called when the given child is removed and in the stable state.
-
-
-protected voidonInfoChanged DSInfo info)Called when the given info is modified and in the stable state.
-
-
-ActionResult onInvoke DSInfo actionInfo,
- ActionInvocation invocation)Override point, called by the default implementation of DSAction.invoke.
-
-
-voidonSet DSInfo info,
- DSIValue value)Override point, called when a value being set.
-
-
-voidonSet DSIValue value)Override point, called only when a DSNode subclass implements DSIValue is being set.
-
-
-protected voidonStable Called once this node is stable, but before stable is called on children.
-
-
-protected voidonStarted Called once this node and its entire subtree is started.
-
-
-protected voidonStopped Called once this node and its entire subtree is stopped.
-
-
-protected voidonSubscribe DSTopic topic,
- DSInfo child,
- DSISubscriber subscriber)Called for every subscription.
-
-
-protected voidonSubscribed Called when this node transitions from having no subscriptions to having a subscription of
- any kind.
-
-
-protected voidonSubscribed DSTopic topic,
- DSInfo child)Called when the child and topic pair transitions from having no subscriptions to have a
- subscription.
-
-
-protected voidonUnsubscribe DSTopic topic,
- DSInfo child,
- DSISubscriber subscriber)Called for every unsubscribe.
-
-
-protected voidonUnsubscribed Called when this node transitions to having no subscriptions of any kind.
-
-
-protected voidonUnsubscribed DSTopic topic,
- DSInfo child)Called when the child and topic pair transitions to having no subscriptions.
-
-
-DSNode put DSInfo info,
- DSIObject object)Replaces the child.
-
-
-DSInfo put A convenience for put(String, DSIObject)
-
-
-DSInfo put A convenience for put(String, DSIObject)
-
-
-DSInfo put DSIObject object)Adds or replaces the named child.
-
-
-DSInfo put A convenience for put(String, DSIObject)
-
-
-DSInfo put A convenience for put(String, DSIObject)
-
-
-DSInfo put A convenience for put(String, DSIObject)
-
-
-DSInfo put A convenience for put(String, DSIObject)
-
-
-DSNode remove DSInfo info)Removes the child.
-
-
-DSInfo remove Remove the named child if it is contained.
-
-
-voidstable Called after the entire subtree is started.
-
-
-voidstart Sets the state to starting.
-
-
-voidstop Sets the state to stopped.
-
-
-voidsubscribe DSTopic topic,
- DSInfo child,
- DSISubscriber subscriber)Subscribes the child and topic.
-
-
-protected static DSNode toNode A convenience that casts the argument to a node.
-
-
-voidunsubscribe DSTopic topic,
- DSInfo child,
- DSISubscriber subscriber)Unsubscribes the tuple.
-
-
-protected voidvalidateChild DSIObject obj)Override point, throw a meaningful IllegalArgumentException if the child is not allowed
-
-
-protected voidvalidateParent DSNode node)Override point, throw a meaningful IllegalArgumentException if the parent is not allowed
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.logging.DSLogger
-admin , admin , admin , debug , debug , debug , error , error , error , fatal , fatal , fatal , fine , fine , fine , info , info , info , trace , trace , trace , warn , warn , warn
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-Methods inherited from interface java.lang.Iterable
-forEach, spliterator
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSNode
-public DSNode()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-add
-public DSInfo add(java.lang.String name,
- DSIObject object)
-Adds the named child only if the name is not already in use.
-
-Parameters: name - The name must not currently be in use.object - The object to add, nodes must not already be parented.Returns: Info for the newly added child.
-Throws: java.lang.IllegalArgumentException - If the name is in use or the value is a node that is already
- parented.
-
-
-
-
-
-
-
-childCount
-public int childCount()
-The number of children.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-declareDefault
-protected DSInfo declareDefault(java.lang.String name,
- DSIObject value)
-Use this in the declareDefaults method to create a non-removable child. This is only called
- on the default instance. Runtime instances clone the declared defaults found on the default
- instance.
-
-Returns: Info for the newly created child.
-See Also: declareDefaults()
-
-
-
-
-
-
-
-declareDefaults
-protected void declareDefaults()
-The is only called once for each class. It's purpose is to define the default children of
- the node subtype. Use the declareDefault method to add non-removable children that all
- runtime instances should have. Be sure to call super.declareDefaults().
-
-See Also: To create non-removable children.
-
-
-
-
-
-
-
-fire
-protected void fire(DSTopic topic,
- DSIEvent event,
- DSInfo child)
-Notifies subscribers of the event.
-
-Parameters: topic - Must not be null.event - Must not be null.child - Can be null.
-
-
-
-
-
-
-
-fire
-protected void fire(DSTopic topic,
- DSIEvent event,
- DSInfo child,
- java.lang.Object... params)
-Notifies subscribers of the event.
-
-Parameters: topic - Must not be null.event - Must not be null.child - Can be null.params - Optional
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getInfo
-public DSInfo getInfo(java.lang.String name)
-Returns the info for the child with the given name, or null.
-
-Returns: Possibly null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-getMetadata
-public void getMetadata(DSInfo info,
- DSMap bucket)
-Override point, add any meta data for the given info to the provided bucket.
-
-
-
-
-
-
-
-getName
-public java.lang.String getName()
-Returns the name of this node in its parent, or null if un-parented.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object arg)
-True if the argument is a node with the same children, although their order can be
- different.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isNull
-public boolean isNull()
-Returns false.
-
-Specified by: isNull DSIObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isSubscribed
-public boolean isSubscribed(DSInfo child,
- DSTopic topic)
-True if there are any subscriptions with the matching child and topic.
-
-Parameters: child - Can be null.topic - Can be null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-onInvoke
-public ActionResult onInvoke(DSInfo actionInfo,
- ActionInvocation invocation)
-Override point, called by the default implementation of DSAction.invoke. You should call
- super.onInvoke if you do not handle an incoming invocation. However, do not call super if
- you do.
-
-Parameters: actionInfo - Child info for the action, you can declare a field for the action info for
- quick instance comparison.invocation - Details about the incoming invoke as well as the mechanism to send updates
- over an open stream.Returns: It is okay to return null if the action result type is void.
-Throws: java.lang.IllegalStateException - If the nothing handles an incoming invocation.See Also: DSAction.invoke(DSInfo, ActionInvocation)
-
-
-
-
-
-
-
-onSet
-public void onSet(DSInfo info,
- DSIValue value)
-Override point, called when a value being set. The default implementation calls put(info,
- value). Throw an exception to report an error to the requester.
-
-Parameters: info - The child being changed.value - The new value.See Also: DSIResponder.onSet(InboundSetRequest)
-
-
-
-
-
-
-
-onSet
-public void onSet(DSIValue value)
-Override point, called only when a DSNode subclass implements DSIValue is being set. This
- will throw and IllegalStateException if not overridden. You should store the value of the
- node as a child and call put in override implementation. Throw an exception to
- report an error to the requester.
-
-Parameters: value - The new value.See Also: DSIResponder.onSet(InboundSetRequest)DSValueNode
-
-
-
-
-
-
-
-onSubscribe
-protected void onSubscribe(DSTopic topic,
- DSInfo child,
- DSISubscriber subscriber)
-Called for every subscription.
-
-Parameters: topic - Will not be null.child - Can be null.subscriber - Will not be null.
-
-
-
-
-
-
-
-
-
-
-
-onSubscribed
-protected void onSubscribed(DSTopic topic,
- DSInfo child)
-Called when the child and topic pair transitions from having no subscriptions to have a
- subscription.
-
-Parameters: child - Can be null, which indicates node subscriptions.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-onUnsubscribe
-protected void onUnsubscribe(DSTopic topic,
- DSInfo child,
- DSISubscriber subscriber)
-Called for every unsubscribe.
-
-Parameters: topic - Will not be null.child - Can be null.subscriber - Will not be null.
-
-
-
-
-
-
-
-
-
-
-
-onUnsubscribed
-protected void onUnsubscribed(DSTopic topic,
- DSInfo child)
-Called when the child and topic pair transitions to having no subscriptions.
-
-Parameters: topic - Can not be null.child - Can be null.
-
-
-
-
-
-
-
-put
-public DSInfo put(java.lang.String name,
- DSIObject object)
-Adds or replaces the named child. If adding, add(String,DSIObject) will be called.
-
-Returns: The info for the child.
-
-
-
-
-
-
-
-
-put
-public DSInfo put(java.lang.String name,
- boolean arg)
-A convenience for put(String, DSIObject)
-
-Returns: The info for the child.
-
-
-
-
-
-
-
-
-put
-public DSInfo put(java.lang.String name,
- double arg)
-A convenience for put(String, DSIObject)
-
-Returns: The info for the child.
-
-
-
-
-
-
-
-
-put
-public DSInfo put(java.lang.String name,
- float arg)
-A convenience for put(String, DSIObject)
-
-Returns: The info for the child.
-
-
-
-
-
-
-
-
-put
-public DSInfo put(java.lang.String name,
- int arg)
-A convenience for put(String, DSIObject)
-
-Returns: The info for the child.
-
-
-
-
-
-
-
-
-put
-public DSInfo put(java.lang.String name,
- long arg)
-A convenience for put(String, DSIObject)
-
-Returns: The info for the child.
-
-
-
-
-
-
-
-
-put
-public DSInfo put(java.lang.String name,
- java.lang.String arg)
-A convenience for put(String, DSIObject)
-
-Returns: The info for the child.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-subscribe
-public void subscribe(DSTopic topic,
- DSInfo child,
- DSISubscriber subscriber)
-Subscribes the child and topic.
-
-Parameters: topic - Can not be null.child - Can be null, and cannot be a child node.subscriber - Can not be null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-validateChild
-protected void validateChild(DSIObject obj)
-Override point, throw a meaningful IllegalArgumentException if the child is not allowed
-
-
-
-
-
-
-
-validateParent
-protected void validateParent(DSNode node)
-Override point, throw a meaningful IllegalArgumentException if the parent is not allowed
-
-
-
-
-
-
-
DSNull (dslink-core 0.19.0 API)
-DSNull (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-All Implemented Interfaces:
-DSIObject , DSIValue
-public class DSNull
-extends DSElement
-Try not to use, it is for decoding raw json. Try to use strong typed null instances instead
- (e.g. DBool.NULL).
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSNull NULL
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-isBoolean , isBytes , isDouble , isEqual , isFloat , isGroup , isInt , isList , isLong , isMap , isNumber , isString , make , make , make , make , make , make , makeNull , toBoolean , toBytes , toDouble , toFloat , toGroup , toInt , toList , toLong , toMap
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
DSPath (dslink-core 0.19.0 API)
-DSPath (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.DSPath
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSPath
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static java.lang.StringBuilderconcat Concatenates the two paths into the given bucket.
-
-
-static java.lang.StringdecodeName Un-escapes a name.
-
-
-static java.lang.String[]decodePath Splits the path and decodes each individual name.
-
-
-static java.lang.StringencodeName Encodes a name for being in a path.
-
-
-static booleanencodeName Encodes a name for being in a path.
-
-
-static booleanencodeNameV1 Encodes a DSA v1 name for use outside of a path.
-
-
-static java.lang.StringencodePath Creates a properly encoded path from the given names.
-
-
-static java.lang.StringencodePath Creates a properly encoded path from the given names.
-
-
-static java.lang.StringencodePath DSNode node)Ascends the tree and encodes all the node names into a path.
-
-
-java.lang.StringgetLastPathElement
-
-java.lang.StringgetPath The raw fully encoded path.
-
-
-java.lang.String[]getPathElements The individual, decoded path elements.
-
-
-static java.lang.String[]splitPath Splits the path, but does not decode any names.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-concat
-public static java.lang.StringBuilder concat(java.lang.String leading,
- java.lang.String trailing,
- java.lang.StringBuilder bucket)
-Concatenates the two paths into the given bucket. Insures a single forward slash character
- separates them. The bucket will not be cleared, the path will be appended to it.
-
-Parameters: bucket - Can be null, in which case a new buffer will be created.Returns: The given bucket, or a new one if that was null, with the complete path appended.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-encodePath
-public static java.lang.String encodePath(boolean leadingSlash,
- java.lang.String... names)
-Creates a properly encoded path from the given names.
-
-Parameters: leadingSlash - Whether or not to prepend a slash to the path.names - The names to encode in the given order.Returns: A properly encoded path name.
-
-
-
-
-
-
-
-
-encodePath
-public static java.lang.String encodePath(boolean leadingSlash,
- java.lang.String[] names,
- int len)
-Creates a properly encoded path from the given names.
-
-Parameters: leadingSlash - Whether or not to prepend a slash to the path.names - The names to encode in the given order.len - The number of elements from the names array to use start at index 0.Returns: A properly encoded path name.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-encodeName
-public static boolean encodeName(java.lang.String name,
- java.lang.StringBuilder buf)
-Encodes a name for being in a path.
-
-Parameters: name - The raw un-encoded name.buf - When to put the encoded name. Characters will be put into the buf no matter
- what.Returns: True if the name was modified in any way.
-
-
-
-
-
-
-
-
-encodeNameV1
-public static boolean encodeNameV1(java.lang.String name,
- java.lang.StringBuilder buf)
-Encodes a DSA v1 name for use outside of a path.
-
-Returns: True if the name was modified in any way.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-splitPath
-public static java.lang.String[] splitPath(java.lang.String path)
-Splits the path, but does not decode any names. The difference between this and
- String.split() is that String.split() will return an empty string at index 0 if the path
- starts with /.
-
-Returns: Never null, but could be an empty array.
-
-
-
-
-
-
-
-
DSRegistry (dslink-core 0.19.0 API)
-DSRegistry (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.DSRegistry
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSRegistry
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSRegistry
-public DSRegistry()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-registerDecoder
-public static void registerDecoder(java.lang.Class clazz,
- DSIValue instance)
-DSIValues must provide an instance for decoding.
-
-Parameters: clazz - The type the instance is for.instance - An instance to use for decoding.
-
-
-
-
-
-
-
DSStatus (dslink-core 0.19.0 API)
-DSStatus (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static intCONFIG_FAULT Bad, a configuration error has been indentified within DSA.
-
-
-static java.lang.StringCONFIG_FAULT_STR
-
-static DSStatus configFault
-
-static DSStatus disabled
-
-static intDISABLED Bad, the object has been disabled within DSA.
-
-
-static java.lang.StringDISABLED_STR
-
-static DSStatus down
-
-static intDOWN Bad, communications are down within DSA.
-
-
-static java.lang.StringDOWN_STR
-
-static DSStatus fault
-
-static intFAULT Bad, an operational error (exception) has occurred within DSA.
-
-
-static java.lang.StringFAULT_STR
-
-static DSStatus NULL
-
-static DSStatus ok
-
-static intOK Good, no other status applies.
-
-
-static intOK_OVERRIDE Good, the value is overridden within DSA.
-
-
-static java.lang.StringOK_OVERRIDE_STR
-
-static intOK_REMOTE_OVERRIDE Good, the value is overridden outside of DSA.
-
-
-static java.lang.StringOK_REMOTE_OVERRIDE_STR
-
-static java.lang.StringOK_STR
-
-static DSStatus okOverride
-
-static DSStatus okRemoteOverride
-
-static intREMOTE_CONFIG_FAULT Bad, a configuration error is being reported by the foreign system.
-
-
-static java.lang.StringREMOTE_CONFIG_FAULT_STR
-
-static intREMOTE_DISABLED Bad, the foreign system is reporting the object is disabled.
-
-
-static java.lang.StringREMOTE_DISABLED_STR
-
-static intREMOTE_DOWN Bad, down communications are being reported by the foreign system.
-
-
-static java.lang.StringREMOTE_DOWN_STR
-
-static intREMOTE_FAULT Bad, an operational error is being reported by the foreign system.
-
-
-static java.lang.StringREMOTE_FAULT_STR
-
-static intREMOTE_STALE Bad, a stale value is being reported by the foreign system.
-
-
-static java.lang.StringREMOTE_STALE_STR
-
-static intREMOTE_UNKNOWN Bad, the foreign system is reporting the status is unknown.
-
-
-static java.lang.StringREMOTE_UNKNOWN_STR
-
-static DSStatus remoteConfigFault
-
-static DSStatus remoteDisabled
-
-static DSStatus remoteDown
-
-static DSStatus remoteFault
-
-static DSStatus remoteStale
-
-static DSStatus remoteUnknown
-
-static DSStatus stale
-
-static intSTALE Bad, the value hasn't updated in a reasonable amount of time (user configurable on a per
- point basis) within DSA.
-
-
-static java.lang.StringSTALE_STR
-
-static DSStatus unknown
-
-static intUNKNOWN Bad, the status is unknown within DSA, typically the initial state at boot.
-
-
-static java.lang.StringUNKNOWN_STR
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-STALE
-public static final int STALE
-Bad, the value hasn't updated in a reasonable amount of time (user configurable on a per
- point basis) within DSA.
-
-See Also: Constant Field Values
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-UNKNOWN
-public static final int UNKNOWN
-Bad, the status is unknown within DSA, typically the initial state at boot.
-
-See Also: Constant Field Values
-
-
-
-
-
-
-
-
-
-
-
-REMOTE_DOWN
-public static final int REMOTE_DOWN
-Bad, down communications are being reported by the foreign system.
-
-See Also: Constant Field Values
-
-
-
-
-
-
-
-REMOTE_FAULT
-public static final int REMOTE_FAULT
-Bad, an operational error is being reported by the foreign system.
-
-See Also: Constant Field Values
-
-
-
-
-
-
-
-REMOTE_CONFIG_FAULT
-public static final int REMOTE_CONFIG_FAULT
-Bad, a configuration error is being reported by the foreign system.
-
-See Also: Constant Field Values
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isOk
-public boolean isOk()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isStale
-public boolean isStale()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-restore
-public DSStatus restore(DSElement arg)
-
-Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-Specified by: restore DSIStorable
-
-
-
-
-
-
-
-toElement
-public DSString toElement()
-Description copied from interface: DSIValue The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests. This is not for configuration database serialization.
-
-Specified by: toElement DSIValue
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-valueOf
-public DSStatus valueOf(DSElement element)
-Description copied from interface: DSIValue This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-Specified by: valueOf DSIValue
-
-
-
-
-
-
-
-
-
-
-
DSString (dslink-core 0.19.0 API)
-DSString (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSString EMPTY The string of length 0.
-
-
-static DSString NULL
-
-static java.nio.charset.CharsetUTF8 The standard UTF8 charset, can be used with string.getBytes(Charset).
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSElement
-copy , isBoolean , isBytes , isDouble , isEqual , isFloat , isGroup , isInt , isList , isLong , isMap , isNull , isNumber , make , make , make , make , make , make , makeNull , toBytes , toDouble , toElement , toFloat , toGroup , toInt , toList , toLong , toMap
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-UTF8
-public static final java.nio.charset.Charset UTF8
-The standard UTF8 charset, can be used with string.getBytes(Charset).
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-toBoolean
-public boolean toBoolean()
-
-Attempts to return a boolean value. Numerics will return false for 0 and true for anything
- else. Strings should return true for "true" or "1" and false for "false" or "0". Anything
- else will throws a ClassCastException.
-
-Overrides: toBoolean DSElement
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSValue (dslink-core 0.19.0 API)
-DSValue (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSValue
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSValue
-public DSValue()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString in class java.lang.Object
-
-
-
-
-
-
-
DSValueNode (dslink-core 0.19.0 API)
-DSValueNode (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-All Implemented Interfaces:
-java.lang.Iterable<DSInfo >, DSILevels , DSIObject , DSIValue
-
-public abstract class DSValueNode
-extends DSNode
-implements DSIValue
-A convenience implementation of a node that is also a value. The value of the node must be
- stored as a child. Subclasses only need to override is getValueChild()
-
-See Also: getValueChild()
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-Fields inherited from interface org.iot.dsa.logging.DSILevels
-admin , ADMIN , all , CONFIG , debug , DEBUG , error , ERROR , fatal , FATAL , fine , FINE , info , INFO , off , trace , TRACE , warn , WARN
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSValueNode
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-abstract DSInfo getValueChild Subclasses must store the node value in a child value and provide the info for that child
- here.
-
-
-DSValueType getValueType The DSA type mapping.
-
-
-voidonChildChanged DSInfo child)This fires the NODE_CHANGED topic when the value child changes.
-
-
-voidonSet DSIValue value)Override point, called only when a DSNode subclass implements DSIValue is being set.
-
-
-DSElement toElement The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-
-DSIValue valueOf DSElement element)This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-
-
-
-
-
-Methods inherited from class org.iot.dsa.node.DSNode
-add , childCount , clear , contains , copy , declareDefault , declareDefaults , fire , fire , get , getElement , getFirst , getFirstInfo , getFirstNodeInfo , getInfo , getInfo , getLast , getLastInfo , getLogName , getMetadata , getName , getNode , getParent , getPath , getValue , isDefaultInstance , isEqual , isIdentical , isNode , isNull , isRunning , isStable , isStarted , isStopped , isSubscribed , isSubscribed , isSubscribed , iterateNodes , iterateValues , iterator , onChildAdded , onChildRemoved , onInfoChanged , onInvoke , onSet , onStable , onStarted , onStopped , onSubscribe , onSubscribed , onSubscribed , onUnsubscribe , onUnsubscribed , onUnsubscribed , put , put , put , put , put , put , put , put , remove , remove , stable , start , stop , subscribe , toNode , unsubscribe , validateChild , validateParent
-
-
-
-
-Methods inherited from class org.iot.dsa.logging.DSLogger
-admin , admin , admin , debug , debug , debug , error , error , error , fatal , fatal , fatal , fine , fine , fine , info , info , info , trace , trace , trace , warn , warn , warn
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-Methods inherited from interface java.lang.Iterable
-forEach, spliterator
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSValueNode
-public DSValueNode()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-getValueChild
-public abstract DSInfo getValueChild()
-Subclasses must store the node value in a child value and provide the info for that child
- here. This method will be called often, it would be best to cache the info instance
- rather then doing a name lookup each time.
-
-
-
-
-
-
-
-toElement
-public DSElement toElement()
-Description copied from interface: DSIValue The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests. This is not for configuration database serialization.
-
-Specified by: toElement DSIValue
-
-
-
-
-
-
-
-onSet
-public void onSet(DSIValue value)
-Description copied from class: DSNode Override point, called only when a DSNode subclass implements DSIValue is being set. This
- will throw and IllegalStateException if not overridden. You should store the value of the
- node as a child and call put in override implementation. Throw an exception to
- report an error to the requester.
-
-Overrides: onSet DSNode Parameters: value - The new value.See Also: DSIResponder.onSet(InboundSetRequest)DSValueNode
-
-
-
-
-
-
-
-valueOf
-public DSIValue valueOf(DSElement element)
-Description copied from interface: DSIValue This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-Specified by: valueOf DSIValue
-
-
-
-
-
-
-
DSValueType (dslink-core 0.19.0 API)
-DSValueType (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Enum<DSValueType >
-
-
-org.iot.dsa.node.DSValueType
-
-
-
-
-
-
-
-
-
-All Implemented Interfaces:
-java.io.Serializable, java.lang.Comparable<DSValueType >
-
-public enum DSValueType
-extends java.lang.Enum<DSValueType >
-These are the primitive types in the DSA protocol. Not all primitive types translate to the JSON
- type system, unlike DSElementType which does.
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static DSValueType valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
-
-
-
-
ActionInvocation (dslink-core 0.19.0 API)
-ActionInvocation (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-voidclearAllRows Only use with stream and open tables, instructs the requester to clear all existing rows.
-
-
-voidclose For use with streams and open tables, will have no effect if the stream is already closed.
-
-
-voidclose Close and send and error.
-
-
-DSMap getParameters The parameters supplied by the requester, or null.
-
-
-DSPermission getPermission The permission level of the invoker, should be verified against the permission level required
- by the action.
-
-
-voidinsert DSList ... rows)Only use with open tables, insert the rows at the given index.
-
-
-booleanisOpen Whether or not response is still open.
-
-
-voidreplace DSList ... rows)Only use with open tables, deletes len rows starting at the given index, then inserts the
- given rows in their place.
-
-
-voidsend DSList row)Only use with stream and open tables.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-close
-void close(java.lang.Exception reason)
-Close and send and error. For use with streams and open tables, will have no effect if the
- stream is already closed.
-
-
-
-
-
-
-
-
-
-
-
-getPermission
-DSPermission getPermission()The permission level of the invoker, should be verified against the permission level required
- by the action.
-
-
-
-
-
-
-
-insert
-void insert(int index,
- DSList ... rows)
-Only use with open tables, insert the rows at the given index.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-replace
-void replace(int idx,
- int len,
- DSList ... rows)
-Only use with open tables, deletes len rows starting at the given index, then inserts the
- given rows in their place.
-
-Parameters: idx - Delete len rows starting at this index and replace with the given rows.len - Does not have to match the number of rows.rows - Does not have to match the len.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- ActionResult (dslink-core 0.19.0 API)
-ActionResult (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- ActionSpec.ResultType (dslink-core 0.19.0 API)
-ActionSpec.ResultType (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-Enum Constants
-Enum Constant and Description
-
-
-CLOSED_TABLE A finite sized table whose stream is closed when the row iterator is complete.
-
-
-OPEN_TABLE A finite sized table whose stream is left open after the row iterator is complete because
- it can change over time.
-
-
-STREAM_TABLE A stream of rows.
-
-
-VALUES One or more return values.
-
-
-VOID No return value.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Detail
-
-
-
-
-
-
-
-
-
-OPEN_TABLE
-public static final ActionSpec.ResultType OPEN_TABLE
-A finite sized table whose stream is left open after the row iterator is complete because
- it can change over time. The row iterator does not have to represent the entire table.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static ActionSpec.ResultType valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
-isClosed
-public boolean isClosed()
-True if CLOSED_TABLE, VOID, or VALUES.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isVoid
-public boolean isVoid()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
ActionSpec (dslink-core 0.19.0 API)
-ActionSpec (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Interface and Description
-
-
-static class ActionSpec.ResultType Defines what the action returns.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- ActionTable (dslink-core 0.19.0 API)
-ActionTable (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Abstract Methods
-Modifier and Type
-Method and Description
-
-
-java.util.Iterator<DSMap >getColumns Column definitions, optional but highly recommended.
-
-
-java.util.Iterator<DSList >getRows This should return an iterator for the initial set of rows, or null if there aren't any.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-getColumns
-java.util.Iterator<DSMap > getColumns()
-Column definitions, optional but highly recommended. The map should have a unique name and a
- value type, use the metadata utility class to build the map.
-
-See Also: DSMetadata
-
-
-
-
-
-
-
-getRows
-java.util.Iterator<DSList > getRows()
-This should return an iterator for the initial set of rows, or null if there aren't any.
- Subsequent calls should just return null unless documented otherwise.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- ActionValues (dslink-core 0.19.0 API)
-ActionValues (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSAction (dslink-core 0.19.0 API)
-DSAction (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.action.DSAction
-
-
-
-
-
-
-
-All Implemented Interfaces:
-ActionSpec , DSIObject
-public class DSAction
-extends java.lang.Object
-implements ActionSpec , DSIObject
-Fully describes an action and routes invocations to DSNode.onInvoke.
-
- Permissions
- Permissions are determined using info flags. If the admin flag is set,
- the action requires admin level permissions. If the action is readonly, then only read
- permissions are required. Otherwise the action will require write permissions.
-
-See Also: DSNode.onInvoke(DSInfo, ActionInvocation)
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSAction DEFAULT Use this when you have no-arg, no-return actions.
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSAction
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSMetadata addDefaultParameter DSIValue value,
- java.lang.String description)A convenience which calls addParameter with the same arguments, and also sets the metadata
- for the default value.
-
-
-DSAction addParameter DSMap metadata)Fully describes a parameter for method invocation.
-
-
-DSMetadata addParameter DSIValue value,
- java.lang.String description)Creates a DSMetadata, calls setName and setType on it, adds the internal map to the parameter
- list and returns the metadata instance for further configuration.
-
-
-DSMetadata addParameter DSValueType type,
- java.lang.String description)Creates a DSMetadata, calls setName and setType on it, adds the internal map to the parameter
- list and returns the metadata instance for further configuration.
-
-
-DSAction addValueResult DSMap metadata)Fully describes a return value when the result type is VALUES.
-
-
-DSMetadata addValueResult DSIValue value)Creates a DSMetadata, calls setName and setType on it, adds the internal map to the results
- list and returns the metadata instance for further configuration.
-
-
-DSMetadata addValueResult DSValueType type)Creates a DSMetadata, calls setName and setType on it, adds the internal map to the results
- list and returns the metadata instance for further configuration.
-
-
-DSAction copy Return a copy if it makes sense, but return this otherwise.
-
-
-java.util.Iterator<DSMap >getParameters Returns an iterator for each parameter.
-
-
-DSPermission getPermission Not used.
-
-
-ActionSpec.ResultType getResultType What the action returns.
-
-
-java.util.Iterator<DSMap >getValueResults This is only called for the VALUES result type.
-
-
-ActionResult invoke DSInfo info,
- ActionInvocation invocation)Calls onInvoke on the proper node.
-
-
-booleanisEqual Defaults to the equals method.
-
-
-booleanisNull False
-
-
-voidprepareParameter DSInfo info,
- DSMap parameter)Override point, called for each parameter as it is being sent to the requester.
-<<<<<<< HEAD
-
-
-DSAction setPermission DSPermission permission)Returns this, it is not necessary to set the permission to read.
-=======
->>>>>>> 22064982f1faddb35f2da7c8a183dbbc8602cbe9
-
-
-DSAction setResultType ActionSpec.ResultType result)Returns this, it is not necessary to set the result to void.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-DEFAULT
-public static final DSAction DEFAULT
-Use this when you have no-arg, no-return actions. This instance cannot be modified.
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSAction
-public DSAction()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-addDefaultParameter
-public DSMetadata addDefaultParameter(java.lang.String name,
- DSIValue value,
- java.lang.String description)
-A convenience which calls addParameter with the same arguments, and also sets the metadata
- for the default value.
-
-Parameters: name - Must not be null.value - Must not be null.description - Can be null.Returns: Metadata for further configuration.
-
-
-
-
-
-
-
-
-addParameter
-public DSAction addParameter(DSMap metadata)
-Fully describes a parameter for method invocation. At the very least, the map should have a
- unique name and a value type. You should use the metadata utility class to build the map.
-
-Returns: This.
-See Also: DSMetadata
-
-
-
-
-
-
-
-addParameter
-public DSMetadata addParameter(java.lang.String name,
- DSIValue value,
- java.lang.String description)
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the parameter
- list and returns the metadata instance for further configuration.
-
-Parameters: name - Must not be null.value - Must not be null.description - Can be null.Returns: Metadata for further configuration.
-
-
-
-
-
-
-
-
-addParameter
-public DSMetadata addParameter(java.lang.String name,
- DSValueType type,
- java.lang.String description)
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the parameter
- list and returns the metadata instance for further configuration.
-
-Parameters: name - Must not be null.type - Must not be null.description - Can be null.Returns: Metadata for further configuration.
-
-
-
-
-
-
-
-
-addValueResult
-public DSAction addValueResult(DSMap metadata)
-Fully describes a return value when the result type is VALUES. Must be added in the order
- that the values will be returned. At the very least, the map should have a unique name and a
- value type, use the DSMetadata utility class.
-
-Returns: This.
-See Also: DSMetadata
-
-
-
-
-
-
-
-addValueResult
-public DSMetadata addValueResult(java.lang.String name,
- DSIValue value)
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the results
- list and returns the metadata instance for further configuration.
-
-Parameters: name - Must not be null.value - Must not be null.Returns: Metadata for further configuration.
-
-
-
-
-
-
-
-
-addValueResult
-public DSMetadata addValueResult(java.lang.String name,
- DSValueType type)
-Creates a DSMetadata, calls setName and setType on it, adds the internal map to the results
- list and returns the metadata instance for further configuration.
-
-Parameters: name - Must not be null.type - Must not be null.Returns: Metadata for further configuration.
-
-
-
-
-
-
-
-
-
-
-
-
-getPermission
-public DSPermission getPermission()
-Not used. Permissions are determined using info flags. If the admin flag is set,
- the action requires admin level permissions. If the action is readonly, then only read
- permissions are required. Otherwise the action will require write permissions.
-
-Specified by: getPermission ActionSpec Returns: Never null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-invoke
-public ActionResult invoke(DSInfo info,
- ActionInvocation invocation)
-Calls onInvoke on the proper node. If this is overridden, do not use the outer 'this' of
- inner classes since that will point to the default instance which should not be touched. This
- can be called on actions stored on default instances, so the actual target of the invocation
- is passed as a parameter.
-
-Parameters: info - The info about the action in it's parent container. Never use the outer
- 'this' of anonymous instances.invocation - Details about the incoming invoke as well as the mechanism to send updates
- over an open stream.Returns: Can be null if the result type is void.
-Throws: java.lang.IllegalStateException - If the target node has not overridden onInvoke.
-
-
-
-
-
-
-
-
-
-
-
-isNull
-public boolean isNull()
-False
-
-Specified by: isNull DSIObject
-
-
-
-<<<<<<< HEAD
-
-
-
-
-prepareParameter
-public void prepareParameter(DSInfo info,
- DSMap parameter)
-Override point, called for each parameter as it is being sent to the requester. Allows you
- for example, to use current values as defaults.
-
-Parameters: info - The info about the action in it's parent container. Never use the outer
- 'this' of anonymous instances.parameter - Map representing a single parameter.
-
-
-
-=======
->>>>>>> 22064982f1faddb35f2da7c8a183dbbc8602cbe9
-
-
-
-
-prepareParameter
-public void prepareParameter(DSInfo info,
- DSMap parameter)
-Override point, called for each parameter as it is being sent to the requester. Allows you
- for example, to use current values as defaults.
-
-Parameters: info - The info about the action in it's parent container. Never use the outer
- 'this' of anonymous instances.parameter - Map representing a single parameter.
-
-
-
-
-
-
-
-
-
-
-
DSActionValues (dslink-core 0.19.0 API)
-DSActionValues (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.action.DSActionValues
-
-
-
-
-
-
-
-All Implemented Interfaces:
-ActionResult , ActionValues
-public class DSActionValues
-extends java.lang.Object
-implements ActionValues
-This is a convenience implementation of ActionValues. It is for actions that return one or
- more values (not tables or streams).
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-
org.iot.dsa.node.action (dslink-core 0.19.0 API)
-org.iot.dsa.node.action (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.iot.dsa.node.action (dslink-core 0.19.0 API)
-org.iot.dsa.node.action (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-ActionInvocation
-Encapsulates the details of an action invocation and provides the mechanism for updating and open
- stream.
-
-
-
-ActionResult
-Super interface for possible results of an action.
-
-
-
-ActionSpec
-Defines an invokable node in the DSA model.
-
-
-
-ActionTable
-Provides access to the columns and rows of a table.
-
-
-
-ActionValues
-Simple set of return values from an action.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSAction
-Fully describes an action and routes invocations to DSNode.onInvoke.
-
-
-
-DSActionValues
-This is a convenience implementation of ActionValues.
-
-
-
-
-
-
-
-Enum Summary
-Enum
-Description
-
-
-
-ActionSpec.ResultType
-Defines what the action returns.
-
-
-
-
-
-
-
org.iot.dsa.node.action Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.node.action Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
DSIEvent (dslink-core 0.19.0 API)
-DSIEvent (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
- DSISubscriber (dslink-core 0.19.0 API)
-DSISubscriber (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-onEvent
-void onEvent(DSTopic topic,
- DSIEvent event,
- DSNode node,
- DSInfo child,
- java.lang.Object... params)
-Subscription callback.
-
-Parameters: topic - Required, the topic emanating the event.event - Required, the actual event.node - Required, node subscribed to.child - Optional, if the event concerns a child.params - Can be null, only used if the event defines it.
-
-
-
-
-
-
-
-onUnsubscribed
-void onUnsubscribed(DSTopic topic,
- DSNode node,
- DSInfo child)
-Called no matter how the unsubscribe happens, whether explicitly or if the node
- unsubscribes itself.
-
-Parameters: topic - The topic that was passed to DSNode.subscribe.node - Node that was passed to DSNode.subscribe, never null.child - The child that was passed to DSNode.subscribe, may be null.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSInfoTopic.Event (dslink-core 0.19.0 API)
-DSInfoTopic.Event (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Enum<DSInfoTopic.Event >
-
-
-org.iot.dsa.node.event.DSInfoTopic.Event
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-Enum Constants
-Enum Constant and Description
-
-
-CHILD_ADDED Events will have a single parameter, the info of the new child.
-
-
-CHILD_REMOVED Events will have a single parameter, the unparented info of the child.
-
-
-METADATA_CHANGED TBD.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Detail
-
-
-
-
-
-CHILD_ADDED
-public static final DSInfoTopic.Event CHILD_ADDED
-Events will have a single parameter, the info of the new child.
-
-
-
-
-
-
-
-CHILD_REMOVED
-public static final DSInfoTopic.Event CHILD_REMOVED
-Events will have a single parameter, the unparented info of the child.
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static DSInfoTopic.Event valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
DSInfoTopic (dslink-core 0.19.0 API)
-DSInfoTopic (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Class and Description
-
-
-static class DSInfoTopic.Event The possible events for this topic.
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSInfoTopic INSTANCE The only instance of this topic.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
- DSTopic (dslink-core 0.19.0 API)
-DSTopic (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.node.event.DSTopic
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSTopic
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSTopic
-public DSTopic()
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-isNull
-public boolean isNull()
-False
-
-Specified by: isNull DSIObject
-
-
-
-
-
-
-
DSValueTopic.Event (dslink-core 0.19.0 API)
-DSValueTopic.Event (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-Enum Constants
-Enum Constant and Description
-
-
-CHILD_CHANGED For node value children (who are not also nodes).
-
-
-NODE_CHANGED For DSNodes that implement DSIValue.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static DSValueTopic.Event valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
DSValueTopic (dslink-core 0.19.0 API)
-DSValueTopic (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Class and Description
-
-
-static class DSValueTopic.Event The possible events from this topic.
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSValueTopic INSTANCE The only instance of this topic.
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Detail:
-Field | Constr |
-Method
-
-
-
-
- org.iot.dsa.node.event (dslink-core 0.19.0 API)
-org.iot.dsa.node.event (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.iot.dsa.node.event (dslink-core 0.19.0 API)
-org.iot.dsa.node.event (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-DSIEvent
-This is an empty interface, DSTopics are allowed to define events however they wish.
-
-
-
-DSISubscriber
-DSISubscribers subscribe to DSTopics on DSNodes.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSInfoTopic
-This topic is for info related events on DSNodes.
-
-
-
-DSTopic
-DSISubscribers subscribe to DSTopics on DSNodes.
-
-
-
-DSValueTopic
-This topic is for change of value events on DSNodes.
-
-
-
-
-
-
-
-
-
-
org.iot.dsa.node.event Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.node.event Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
org.iot.dsa.node (dslink-core 0.19.0 API)
-org.iot.dsa.node (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.iot.dsa.node (dslink-core 0.19.0 API)
-org.iot.dsa.node (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-DSIBoolean
-Indicates something that is/has a boolean value.
-
-
-
-DSIEnum
-DSA Enum mapping.
-
-
-
-DSIMetadata
-Nodes and values can implement this to provide meta-data about themselves.
-
-
-
-DSINumber
-Indicates something that is/has a numeric value.
-
-
-
-DSIObject
-Super class of anything found in the node tree.
-
-
-
-DSIStatus
-Indicates something that is/has a quality.
-
-
-
-DSIStorable
-Enables custom serialization for non-node values in the configuration database.
-
-
-
-DSIValue
-How data values are represented in the node tree.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSBool
-Represents a boolean value.
-
-
-
-DSBytes
-Byte array that gets encoded as a base64 string.
-
-
-
-DSDouble
-A 64 bit floating point (Java double).
-
-
-
-DSElement
-The primitives of the node model.
-
-
-
-DSFlexEnum
-An enum where the value and range can be created at runtime, primarily intended for defining
- action parameters.
-
-
-
-DSFloat
-A Java float.
-
-
-
-DSGroup
-An index accessible collection of primitives.
-
-
-
-DSInfo
-All node children have corresponding DSInfo instances.
-
-
-
-DSInt
-A Java int.
-
-
-
-DSJavaEnum
-Wrapper for Java enums.
-
-
-
-DSList
-Indexed collection of elements.
-
-
-
-DSLong
-A 64 bit integer (a Java long).
-
-
-
-DSMap
-String keyed collection of elements that preserves the order of addition.
-
-
-
-DSMap.Entry
-Allows values to be accessed quickly by index in the list, rather than having to do a key
- lookup in the map.
-
-
-
-DSMetadata
-Utility fon constructing metadata maps.
-
-
-
-DSNode
-The organizational unit of the node tree.
-
-
-
-DSNull
-Try not to use, it is for decoding raw json.
-
-
-
-DSPath
-Represents a path in the node tree.
-
-
-
-DSRegistry
-Static type related meta-data.
-
-
-
-DSStatus
-Represent the health, quality or condition of an object.
-
-
-
-DSString
-String wrapper.
-
-
-
-DSValue
-A convenience that provides some common default behavior.
-
-
-
-DSValueNode
-A convenience implementation of a node that is also a value.
-
-
-
-
-
-
-
-Enum Summary
-Enum
-Description
-
-
-
-DSElementType
-The core set of elements that translate directly to a JSON type.
-
-
-
-DSValueType
-These are the primitive types in the DSA protocol.
-
-
-
-
-
-
-
-
-
-
Package org.iot.dsa.node Description
-
Persistent data model used to build the node tree of a link.
-
org.iot.dsa.node Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.node Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
org.iot.dsa (dslink-core 0.19.0 API)
-org.iot.dsa (dslink-core 0.20.0 API)
-org.iot.dsa (dslink-core 0.19.0 API)
-org.iot.dsa (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSRuntime
-DSA thread pool and timers.
-
-
-
-DSRuntime.Timer
-Can be used to inspect and cancel tasks passed to the run methods in DSRuntime.
-
-
-
-
-
-
-
-
-
-
Package org.iot.dsa Description
-
Use the DSRuntime thread pool and timers.
-
org.iot.dsa Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/javadoc/org/iot/dsa/security/DSIPassword.html b/docs/javadoc/org/iot/dsa/security/DSIPassword.html
deleted file mode 100644
index 51a7bc48..00000000
--- a/docs/javadoc/org/iot/dsa/security/DSIPassword.html
+++ /dev/null
@@ -1,256 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-DSIPassword (dslink-core 0.19.0 API)
-DSIPassword (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- DSKeys.Signer (dslink-core 0.19.0 API)
-DSKeys.Signer (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.security.DSKeys.Signer
-
-
-
-
-
-
-
-Enclosing class:
-DSKeys
-public class DSKeys.Signer
-extends java.lang.Object
-Signs bytes. Call the update one or more times. Call getSignature when finished. This
- object is not thread safe, but can be reused by calling reset to being a new signature.
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Signer
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-update
-public DSKeys.Signer update(byte[] buf,
- int off,
- int len)
-Update the signature with the given bytes.
-
-Parameters: buf - The source of the bytes.off - The offset of the first byte.len - The number of bytes to sign.
-
-
-
-
-
-
-
DSKeys.Verifier (dslink-core 0.19.0 API)
-DSKeys.Verifier (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.security.DSKeys.Verifier
-
-
-
-
-
-
-
-Enclosing class:
-DSKeys
-public static class DSKeys.Verifier
-extends java.lang.Object
-Verifies signatures. Call update one or more times with the bytes of the message. Call
- verify with a signature for the message to validate. This object is not thread safe, but can
- be reused by calling reset to begin a new signature.
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-Verifier
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-DSKeys.Verifier reset Call to begin a new signature.
-
-
-DSKeys.Verifier update Update the signature with the given bytes.
-
-
-DSKeys.Verifier update Update the signature with the given bytes.
-
-
-booleanvalidate Returns true if the given signature is valid for the bytes passed to update.
-
-
-booleanvalidate Returns true if the given base 64 encoded signature is valid for the bytes passed to
- update.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-update
-public DSKeys.Verifier update(byte[] buf,
- int off,
- int len)
-Update the signature with the given bytes.
-
-Parameters: buf - The source of the bytes.off - The offset of the first byte.len - The number of bytes to sign.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSKeys (dslink-core 0.19.0 API)
-DSKeys (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.security.DSKeys
-
-
-
-
-
-
-
-
-
-
-
-
-Nested Class Summary
-
-Nested Classes
-Modifier and Type
-Class and Description
-
-
-class DSKeys.Signer Signs bytes.
-
-
-static class DSKeys.Verifier Verifies signatures.
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSKeys Creates a DSKeys object by decoding existing keys from the given file.
-
-
-DSKeys Creates a DSKeys object for an existing key pair.
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static DSKeys decodeKeys Decodes an instance that was encoded with encodeKeys().
-
-
-static java.security.interfaces.ECPrivateKeydecodePrivate Decodes the X9.63 encoding of a public key.
-
-
-static java.security.interfaces.ECPublicKeydecodePublic Decodes the X9.63 encoding of a public key.
-
-
-java.lang.StringencodeKeys Encodes the key pair which can be then decoded with decodeKeys().
-
-
-byte[]encodePublic X9.63 encoding of the public key.
-
-
-java.lang.StringencodePublicHashDsId Base64 encoding (no padding and url safe) of the SHA256 hash of the public key.
-
-
-static byte[]generateHmacSHA256Signature
-
-byte[]generateSharedSecret Uses the given public key to generate an ECDH shared secret.
-
-
-byte[]generateSharedSecret Uses the given public key to generate an ECDH shared secret.
-
-
-java.security.KeyPairgetKeys The public and private keys.
-
-
-static java.security.spec.ECParameterSpecgetParameters The AlgorithmParameterSpec for the predefined elliptic curve secp256r1.
-
-
-java.security.interfaces.ECPrivateKeygetPrivateKey A convenience that casts the private key.
-
-
-java.security.interfaces.ECPublicKeygetPublicKey A convenience that casts the public key.
-
-
-static java.security.KeyPairnewKeyPair Creates a key pair for the predefined elliptic curve secp256r1.
-
-
-static java.security.SignaturenewSignature Returns a SHA256withECDSA signature.
-
-
-DSKeys.Signer newSigner Creates a signer for this private key.
-
-
-DSKeys.Verifier newVerifier Creates a verifier for this public key.
-
-
-static DSKeys restore Decodes a key pair that was encoded by the store method.
-
-
-static DSKeys restore Decodes a key pair that was encoded by the store method, does not onClose the given stream.
-
-
-java.lang.Stringsign A convenience that creates a signer and signs the given bytes.
-
-
-voidstore Write the bytes from the string encoding to the given file.
-
-
-voidstore Writes the bytes from the string encoding to the given stream, does not onClose the stream.
-
-
-booleanverify A convenience that creates a verifier and validates the signature for the given bytes.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-DSKeys
-public DSKeys(java.io.File keyFile)
-Creates a DSKeys object by decoding existing keys from the given file. If the file does not
- exist, new keys will be created and stored in that file.
-
-Parameters: keyFile - The file to decodeKeys existing keys, or to store newly generated keys.Throws: DSException
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-sign
-public java.lang.String sign(byte[] buf,
- int off,
- int len)
-A convenience that creates a signer and signs the given bytes.
-
-Returns: DSBase64 encoding of the signature.
-
-
-
-
-
-
-
-
-
-
-
-
-restore
-public static DSKeys restore(java.io.InputStream in)
-Decodes a key pair that was encoded by the store method, does not onClose the given stream.
-
-Parameters: in - Stream containing the serialized keys, will not be closed.Throws: DSException
-
-
-
-
-
-
-
-
-
-
-
-store
-public void store(java.io.OutputStream out)
-Writes the bytes from the string encoding to the given stream, does not onClose the stream.
-
-Parameters: out - Where write the serialized keys, will not be closed.Throws: DSException
-
-
-
-
-
-
-
-verify
-public boolean verify(byte[] buf,
- int off,
- int len,
- java.lang.String signature)
-A convenience that creates a verifier and validates the signature for the given bytes.
-
-
-
-
-
-
-
DSPasswordAes (dslink-core 0.19.0 API)
-DSPasswordAes (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSPasswordAes NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.Stringdecode Returns the decrypted password.
-
-
-static java.lang.Stringencode Encrypts the given bytes.
-
-
-static java.lang.Stringencode Encrypts the given text.
-
-
-booleanequals
-
-DSValueType getValueType The DSA type mapping.
-
-
-inthashCode
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-booleanisValid DSElement clearText)Encrypts the string value of the given element and compares against the value stored in this
- object.
-
-
-booleanisValid Encrypts the given string and compares against the value stored in this object.
-
-
-DSPasswordAes restore DSElement element)Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-
-DSString store Serialize the value for the configuration database.
-
-
-DSString toElement Returns a string representing the url safe base64 encoding of the hash.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-DSPasswordAes valueOf DSElement arg)Creates a encrypted password for the given clear text.
-
-
-static DSPasswordAes valueOf Creates a encrypted password for the given clear text.
-
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-restore
-public DSPasswordAes restore(DSElement element)
-
-Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-Specified by: restore DSIStorable
-
-
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSPasswordSha256 (dslink-core 0.19.0 API)
-DSPasswordSha256 (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static java.lang.Stringencode SHA-256 hash of the bytes encoded as url safe base 64..
-
-
-static java.lang.Stringencode SHA-256 hash of the UTF-8 bytes, encoded as url safe base 64..
-
-
-booleanequals
-
-DSValueType getValueType The DSA type mapping.
-
-
-inthashCode
-
-booleanisEqual Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-booleanisValid DSElement clearText)Hashes the string value of the given element and compares against the hash stored in this
- object.
-
-
-booleanisValid Hashes the given string and compares against the value stored in this object.
-
-
-DSPasswordSha256 restore DSElement element)Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-
-DSString store Serialize the value for the configuration database.
-
-
-DSString toElement Returns a string representing the url safe base64 encoding of the hash.
-
-
-java.lang.StringtoString If isNull(), returns "null", otherwise returns toElement().toString()
-
-
-DSPasswordSha256 valueOf DSElement arg)Creates a digest password for the given clear text.
-
-
-static DSPasswordSha256 valueOf Creates a digest password for the given clear text.
-
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-encode
-public static java.lang.String encode(java.lang.String arg)
-SHA-256 hash of the UTF-8 bytes, encoded as url safe base 64..
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-isEqual
-public boolean isEqual(java.lang.Object obj)
-
-Equals implementation that doesn't require hashCodes to equal, primarily intended
- so for comparing nodes.
-
-Specified by: isEqual DSIObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-restore
-public DSPasswordSha256 restore(DSElement element)
-
-Deserialize a value from the configuration database, these will be values returned from the
- store() method.
-
-Specified by: restore DSIStorable
-
-
-
-
-
-
-
-
-
-
-
-toString
-public java.lang.String toString()
-Description copied from class: DSValue If isNull(), returns "null", otherwise returns toElement().toString()
-
-Overrides: toString DSValue
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSPermission (dslink-core 0.19.0 API)
-DSPermission (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Enum<DSPermission >
-
-
-org.iot.dsa.security.DSPermission
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-Enum Constants
-Enum Constant and Description
-
-
-CONFIG
-
-LIST
-
-READ
-
-WRITE
-
-
-
-
-
-
-
-Method Summary
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static DSPermission valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
-getLevel
-public int getLevel()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-isRead
-public boolean isRead()
-
-
-
-
-
-
-
-isWrite
-public boolean isWrite()
-
-
-
-
-
-
-
-isList
-public boolean isList()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
org.iot.dsa.security (dslink-core 0.19.0 API)
-org.iot.dsa.security (dslink-core 0.20.0 API)
-
-
Interfaces
-
-
Classes
-
-
Enums
-
-
org.iot.dsa.security (dslink-core 0.19.0 API)
-org.iot.dsa.security (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Interface Summary
-Interface
-Description
-
-
-
-DSIPassword
-Defines the api for verifying passwords.
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSKeys
-DSA public private key pair.
-
-
-
-DSKeys.Verifier
-Verifies signatures.
-
-
-
-DSPasswordAes
-Stores an encrypted password which can be decrypted.
-
-
-
-DSPasswordSha256
-Stores and verifies passwords using a SHA-256 hash of the text.
-
-
-
-
-
-
-
-Enum Summary
-Enum
-Description
-
-
-
-DSPermission
-Used to define the required permissions for various objects.
-
-
-
-
-
-
-
org.iot.dsa.security Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.security Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
DSDateTime (dslink-core 0.19.0 API)
-DSDateTime (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-Fields
-Modifier and Type
-Field and Description
-
-
-static DSDateTime NULL
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static DSDateTime currentTime The current time.
-
-
-booleanequals
-
-DSValueType getValueType String.
-
-
-inthashCode
-
-booleanisEqual Defaults to the equals method.
-
-
-booleanisNull Values should have an instance representing null.
-
-
-longtimeInMillis The Java time represented by this object.
-
-
-DSElement toElement The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests.
-
-
-java.lang.StringtoString ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
-
-
-DSDateTime valueOf DSElement element)This should convert an element transmitted over DSA, such as subscription updates or set
- requests.
-
-
-static DSDateTime valueOf
-
-static DSDateTime valueOf Decodes an ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
-
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Field Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hashCode
-public int hashCode()
-
-Overrides: hashCode in class java.lang.Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-toElement
-public DSElement toElement()
-Description copied from interface: DSIValue The current value should convert itself to an element for DSA interop such as subscription
- updates, and setting requests. This is not for configuration database serialization.
-
-
-
-
-
-
-
-
-
-
-
-valueOf
-public DSDateTime valueOf(DSElement element)
-Description copied from interface: DSIValue This should convert an element transmitted over DSA, such as subscription updates or set
- requests. This is not for configuration database deserialization.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSInterval (dslink-core 0.19.0 API)
-DSInterval (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Enum<DSInterval >
-
-
-org.iot.dsa.time.DSInterval
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Enum Constant Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-intcount Returns the number of intervals for the given time range, or -1 if indeterminate.
-
-
-longmillis The approximate number of ms in the interval.
-
-
-longnext Returns the nextRun interval for the previously aligned timestamp.
-
-
-static DSInterval valueOf Returns the enum constant of this type with the specified name.
-
-
-static DSInterval []values Returns an array containing the constants of this enum type, in
-the order they are declared.
-
-
-
-
-
-
-Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
-
-
-
-Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-valueOf
-public static DSInterval valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this type. (Extraneous whitespace characters are
-not permitted.)
-
-Parameters: name - the name of the enum constant to be returned.Returns: the enum constant with the specified name
-Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null
-
-
-
-
-
-
-
-count
-public int count(long start,
- long end)
-Returns the number of intervals for the given time range, or -1 if indeterminate.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
DSTime (dslink-core 0.19.0 API)
-DSTime (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.time.DSTime
-
-
-
-
-
-
-
-
-
-
-
-
-Field Summary
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static java.util.CalendaraddDays Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static longaddDays Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static java.util.CalendaraddHours Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static longaddHours Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static java.util.CalendaraddMinutes Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static longaddMinutes Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static java.util.CalendaraddMonths Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static longaddMonths Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static java.util.CalendaraddSeconds Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static longaddSeconds Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static java.util.CalendaraddWeeks Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static longaddWeeks Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static java.util.CalendaraddYears Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static longaddYears Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
-static java.util.CalendaralignDay Aligns the time fields to the start of the day.
-
-
-static java.util.CalendaralignDays Aligns the time fields to the start of given interval.
-
-
-static java.util.CalendaralignHour Aligns the time fields to the start of the hour.
-
-
-static java.util.CalendaralignHours Aligns the time fields to the start of given interval.
-
-
-static java.util.CalendaralignMinute Aligns the time fields to the start of the minute.
-
-
-static java.util.CalendaralignMinutes Aligns the time fields to the start of given interval.
-
-
-static java.util.CalendaralignMonth Aligns the time fields to the start of the month.
-
-
-static java.util.CalendaralignSecond Aligns the time fields to the start of the second.
-
-
-static java.util.CalendaralignSeconds Aligns the time fields to the start of given interval.
-
-
-static java.util.CalendaralignWeek Aligns the time fields to the start of the week.
-
-
-static java.util.CalendaralignYear Aligns the time fields to the start of the year.
-
-
-static longdecode This is a convenience that uses reuses and recycles a calendar instance to get the time in
- millis.
-
-
-static java.util.Calendardecode Converts a DSA encoded timestamp into a Java Calendar.
-
-
-static java.lang.StringBuilderencode Converts a Java Calendar into a DSA encoded timestamp.
-
-
-static java.lang.StringBuilderencode Converts a Java Calendar into a DSA encoded timestamp.
-
-
-static java.lang.StringBuilderencode Converts a Java Calendar into a DSA encoded timestamp.
-
-
-static java.lang.StringBuilderencodeForFiles Converts a Java Calendar into a number safe for file names: YYMMDDHHMMSS.
-
-
-static java.lang.StringBuilderencodeForLogs Converts a Java Calendar into a shorter human readable timestamp for use in logging files.
-
-
-static java.util.CalendargetCalendar Attempts to reuse a calendar instance, the timezone will be set to TimeZone.getDefault().
-
-
-static java.util.CalendargetCalendar Attempts to reuse a calendar instance and sets the time in millis to the argument and the
- timezone to TimeZone.getDefault().
-
-
-static longmillisToNanos
-
-static longnanosToMillis
-
-static voidrecycle Return a calendar instance for reuse.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-addDays
-public static java.util.Calendar addDays(int count,
- java.util.Calendar timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The calendar to modify.Returns: The timestamp parameter.
-
-
-
-
-
-
-
-
-addDays
-public static long addDays(int count,
- long timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The time to modify.Returns: The adjusted time.
-
-
-
-
-
-
-
-
-addHours
-public static java.util.Calendar addHours(int count,
- java.util.Calendar timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The calendar to modify.Returns: The timestamp parameter.
-
-
-
-
-
-
-
-
-addHours
-public static long addHours(int count,
- long timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The time to modify.Returns: The adjusted time.
-
-
-
-
-
-
-
-
-addMinutes
-public static java.util.Calendar addMinutes(int count,
- java.util.Calendar timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The calendar to modify.Returns: The timestamp parameter.
-
-
-
-
-
-
-
-
-addMinutes
-public static long addMinutes(int count,
- long timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The time to modify.Returns: The adjusted time.
-
-
-
-
-
-
-
-
-addMonths
-public static java.util.Calendar addMonths(int count,
- java.util.Calendar timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The calendar to modify.Returns: The timestamp parameter.
-
-
-
-
-
-
-
-
-addMonths
-public static long addMonths(int count,
- long timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The time to modify.Returns: The adjusted time.
-
-
-
-
-
-
-
-
-addSeconds
-public static java.util.Calendar addSeconds(int count,
- java.util.Calendar timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The calendar to modify.Returns: The timestamp parameter.
-
-
-
-
-
-
-
-
-addSeconds
-public static long addSeconds(int count,
- long timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The time to modify.Returns: The adjusted time.
-
-
-
-
-
-
-
-
-addWeeks
-public static java.util.Calendar addWeeks(int count,
- java.util.Calendar timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The calendar to modify.Returns: The timestamp parameter.
-
-
-
-
-
-
-
-
-addWeeks
-public static long addWeeks(int count,
- long timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The time to modify.Returns: The adjusted time.
-
-
-
-
-
-
-
-
-addYears
-public static java.util.Calendar addYears(int count,
- java.util.Calendar timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The calendar to modify.Returns: The timestamp parameter.
-
-
-
-
-
-
-
-
-addYears
-public static long addYears(int count,
- long timestamp)
-Adds or subtracts the corresponding time field, does not perform any alignment.
-
-Parameters: count - The quantity to change, can be negative.timestamp - The time to modify.Returns: The adjusted time.
-
-
-
-
-
-
-
-
-
-
-
-
-alignDays
-public static java.util.Calendar alignDays(int interval,
- java.util.Calendar timestamp)
-Aligns the time fields to the start of given interval.
-
-Parameters: interval - The number of days in the interval to align to.timestamp - The calendar to align.Returns: The calendar parameter, aligned.
-
-
-
-
-
-
-
-
-
-
-
-
-alignHours
-public static java.util.Calendar alignHours(int interval,
- java.util.Calendar timestamp)
-Aligns the time fields to the start of given interval.
-
-Parameters: interval - The number of hours in the interval to align to.timestamp - The calendar to align.Returns: The calendar parameter, aligned.
-
-
-
-
-
-
-
-
-
-
-
-
-alignMinutes
-public static java.util.Calendar alignMinutes(int interval,
- java.util.Calendar timestamp)
-Aligns the time fields to the start of given interval.
-
-Parameters: interval - The number of minutes in the interval to align to.timestamp - The calendar to align.Returns: The calendar parameter, aligned.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-alignSeconds
-public static java.util.Calendar alignSeconds(int interval,
- java.util.Calendar timestamp)
-Aligns the time fields to the start of given interval.
-
-Parameters: interval - The number of seconds in the interval to align to.timestamp - The calendar to align.Returns: The calendar parameter, aligned.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-decode
-public static java.util.Calendar decode(java.lang.String timestamp,
- java.util.Calendar calendar)
-Converts a DSA encoded timestamp into a Java Calendar. DSA encoding is based on ISO 8601 but
- allows for an unspecified timezone.
-
-Parameters: timestamp - The encoded timestamp.calendar - The instance to decodeKeys into and returnt, may be null. If the timestamp
- does not specify a timezone, the zone in this instance will be used.
-
-
-
-
-
-
-
-encode
-public static java.lang.StringBuilder encode(long timestamp,
- boolean encodeTzOffset)
-Converts a Java Calendar into a DSA encoded timestamp. DSA encoding is based on ISO 8601 but
- allows the timezone offset to not be specified.
-
-Parameters: timestamp - What to encode.encodeTzOffset - Whether or not to encode the timezone offset.Returns: The buffer containing the encoding.
-
-
-
-
-
-
-
-
-encode
-public static java.lang.StringBuilder encode(long timestamp,
- boolean encodeTzOffset,
- java.lang.StringBuilder buf)
-Converts a Java Calendar into a DSA encoded timestamp. DSA encoding is based on ISO 8601 but
- allows the timezone offset to not be specified.
-
-Parameters: timestamp - What to encode.encodeTzOffset - Whether or not to encode the timezone offset.buf - The buffer to append the encoded timestamp and return value, can be
- null.Returns: The buffer containing the encoding.
-
-
-
-
-
-
-
-
-encode
-public static java.lang.StringBuilder encode(java.util.Calendar calendar,
- boolean encodeTzOffset,
- java.lang.StringBuilder buf)
-Converts a Java Calendar into a DSA encoded timestamp. DSA encoding is based on ISO 8601 but
- the timezone offset is optional.
-
-Parameters: calendar - The calendar representing the timestamp to encode.encodeTzOffset - Whether or not to encode the timezone offset.buf - The buffer to append the encoded timestamp and return value, can be
- null.Returns: The buf argument, or if that was null, a new StringBuilder.
-
-
-
-
-
-
-
-
-encodeForFiles
-public static java.lang.StringBuilder encodeForFiles(java.util.Calendar calendar,
- java.lang.StringBuilder buf)
-Converts a Java Calendar into a number safe for file names: YYMMDDHHMMSS. If seconds align to
- 00, then they will be omitted. DSTime.alignMinutes can be used to achieve that.
-
-Parameters: calendar - The calendar representing the timestamp to encode.buf - The buffer to append the encoded timestamp and return, can be null.Returns: The buf argument, or if that was null, a new StringBuilder.
-
-
-
-
-
-
-
-
-encodeForLogs
-public static java.lang.StringBuilder encodeForLogs(java.util.Calendar calendar,
- java.lang.StringBuilder buf)
-Converts a Java Calendar into a shorter human readable timestamp for use in logging files.
-
-Parameters: calendar - The calendar representing the timestamp to encode.buf - The buffer to append the encoded timestamp and return, can be null.Returns: The buf argument, or if that was null, a new StringBuilder.
-
-
-
-
-
-
-
-
-getCalendar
-public static java.util.Calendar getCalendar()
-Attempts to reuse a calendar instance, the timezone will be set to TimeZone.getDefault().
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
org.iot.dsa.time (dslink-core 0.19.0 API)
-org.iot.dsa.time (dslink-core 0.20.0 API)
-org.iot.dsa.time (dslink-core 0.19.0 API)
-org.iot.dsa.time (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSDateTime
-Wrapper for Java time.
-
-
-
-DSTime
-Misc time utility functions.
-
-
-
-
-
-
-
-Enum Summary
-Enum
-Description
-
-
-
-DSInterval
-Enum representing periods of time.
-
-
-
-
-
-
-
org.iot.dsa.time Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.time Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
DSException (dslink-core 0.19.0 API)
-DSException (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-java.lang.Object
-
-
-java.lang.Throwable
-
-
-java.lang.Exception
-
-
-java.lang.RuntimeException
-
-
-org.iot.dsa.util.DSException
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Summary
-
-Constructors
-Constructor and Description
-
-
-DSException
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Instance Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-java.lang.ThrowablegetCause
-
-java.lang.StringgetLocalizedMessage
-
-java.lang.StringgetMessage
-
-java.lang.StackTraceElement[]getStackTrace
-
-java.lang.ThrowableinitCause
-
-static java.lang.StringmakeMessage Attempts come up with the best description of the argument.
-
-
-static java.lang.RuntimeExceptionmakeRuntime If the given exception is already a runtime exception, it is cast and returned,
- otherwise it will be returned wrapped by an instance of this class.
-
-
-voidprintStackTrace
-
-voidprintStackTrace
-
-voidprintStackTrace
-
-static voidthrowRuntime If the given exception is already a runtime exception, it is rethrown, otherwise
- it will be thrown wrapped by an instance of this class.
-
-
-java.lang.StringtoString
-
-
-
-
-
-Methods inherited from class java.lang.Throwable
-addSuppressed, fillInStackTrace, getSuppressed, setStackTrace
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor Detail
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-makeRuntime
-public static java.lang.RuntimeException makeRuntime(java.lang.Throwable x)
-If the given exception is already a runtime exception, it is cast and returned,
- otherwise it will be returned wrapped by an instance of this class.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-throwRuntime
-public static void throwRuntime(java.lang.Throwable x)
-If the given exception is already a runtime exception, it is rethrown, otherwise
- it will be thrown wrapped by an instance of this class.
-
-
-
-
-
-
-
-
-
-
-
DSUtil (dslink-core 0.19.0 API)
-DSUtil (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
-
-
-java.lang.Object
-
-
-org.iot.dsa.util.DSUtil
-
-
-
-
-
-
-
-
-
-
-
-
-Method Summary
-
-All Methods Static Methods Concrete Methods
-Modifier and Type
-Method and Description
-
-
-static booleanequal Comparison that takes null into account; null == null.
-
-
-static booleangetBit Returns true if the bit at the given index is set.
-
-
-static intsetBit Set or unset a bit at the given index.
-
-
-
-
-
-
-Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Detail
-
-
-
-
-
-equal
-public static boolean equal(java.lang.Object o1,
- java.lang.Object o2)
-Comparison that takes null into account; null == null.
-
-
-
-
-
-
-
-getBit
-public static boolean getBit(int bits,
- int index)
-Returns true if the bit at the given index is set.
-
-Parameters: bits - The bitset the check.index - The bit position in the bits argument; 0 is the lowest order bit and 31 is the
- highest order.Returns: True if the target bit is set.
-
-
-
-
-
-
-
-
-setBit
-public static int setBit(int bits,
- int index,
- boolean set)
-Set or unset a bit at the given index.
-
-Parameters: bits - The bitset to modify.index - Which bit to set/unset; 0 is the lowest order bit and 31 is the highest.set - True to set, false to unset.Returns: The adjusted bits.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Summary:
-Nested |
-Field |
-Constr |
-Method
-
-Detail:
-Field |
-Constr |
-Method
-
-
-
- org.iot.dsa.util (dslink-core 0.19.0 API)
-org.iot.dsa.util (dslink-core 0.20.0 API)
-
-
Classes
-
-
Exceptions
-
-
org.iot.dsa.util (dslink-core 0.19.0 API)
-org.iot.dsa.util (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-Class Summary
-Class
-Description
-
-
-
-DSUtil
-Common utilities.
-
-
-
-
-
-
-
-Exception Summary
-Exception
-Description
-
-
-
-DSException
-An runtime exception that forwards most calls to the inner exception.
-
-
-
-
-
-
-
org.iot.dsa.util Class Hierarchy (dslink-core 0.19.0 API)
-org.iot.dsa.util Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-java.lang.Object
-
-org.iot.dsa.util.DSUtil
-java.lang.Throwable (implements java.io.Serializable)
-
-java.lang.Exception
-
-java.lang.RuntimeException
-
-
-
-
-
-
-
-
-
-
Overview List (dslink-core 0.19.0 API)
-Overview List (dslink-core 0.20.0 API)
-
-
-
diff --git a/docs/javadoc/overview-summary.html b/docs/javadoc/overview-summary.html
deleted file mode 100644
index fe932ade..00000000
--- a/docs/javadoc/overview-summary.html
+++ /dev/null
@@ -1,212 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-Overview (dslink-core 0.19.0 API)
-Overview (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/javadoc/overview-tree.html b/docs/javadoc/overview-tree.html
deleted file mode 100644
index fc8eeb92..00000000
--- a/docs/javadoc/overview-tree.html
+++ /dev/null
@@ -1,364 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-Class Hierarchy (dslink-core 0.19.0 API)
-Class Hierarchy (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Class Hierarchy
-
-
Interface Hierarchy
-
-
Enum Hierarchy
-
-java.lang.Object
-
-java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
-
-
-
-
-
-
" + tabs[value][1] + " ";
- }
- }
-}
diff --git a/docs/javadoc/serialized-form.html b/docs/javadoc/serialized-form.html
deleted file mode 100644
index f81c9d35..00000000
--- a/docs/javadoc/serialized-form.html
+++ /dev/null
@@ -1,197 +0,0 @@
-
-
-
-
-<<<<<<< HEAD
-
-Serialized Form (dslink-core 0.19.0 API)
-Serialized Form (dslink-core 0.20.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/javadoc/stylesheet.css b/docs/javadoc/stylesheet.css
deleted file mode 100644
index cebb4fd8..00000000
--- a/docs/javadoc/stylesheet.css
+++ /dev/null
@@ -1,574 +0,0 @@
-/* Javadoc style sheet */
-/*
-Overall document style
-*/
-
-@import url('resources/fonts/dejavu.css');
-
-body {
- background-color:#ffffff;
- color:#353833;
- font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
- font-size:14px;
- margin:0;
-}
-a:link, a:visited {
- text-decoration:none;
- color:#4A6782;
-}
-a:hover, a:focus {
- text-decoration:none;
- color:#bb7a2a;
-}
-a:active {
- text-decoration:none;
- color:#4A6782;
-}
-a[name] {
- color:#353833;
-}
-a[name]:hover {
- text-decoration:none;
- color:#353833;
-}
-pre {
- font-family:'DejaVu Sans Mono', monospace;
- font-size:14px;
-}
-h1 {
- font-size:20px;
-}
-h2 {
- font-size:18px;
-}
-h3 {
- font-size:16px;
- font-style:italic;
-}
-h4 {
- font-size:13px;
-}
-h5 {
- font-size:12px;
-}
-h6 {
- font-size:11px;
-}
-ul {
- list-style-type:disc;
-}
-code, tt {
- font-family:'DejaVu Sans Mono', monospace;
- font-size:14px;
- padding-top:4px;
- margin-top:8px;
- line-height:1.4em;
-}
-dt code {
- font-family:'DejaVu Sans Mono', monospace;
- font-size:14px;
- padding-top:4px;
-}
-table tr td dt code {
- font-family:'DejaVu Sans Mono', monospace;
- font-size:14px;
- vertical-align:top;
- padding-top:4px;
-}
-sup {
- font-size:8px;
-}
-/*
-Document title and Copyright styles
-*/
-.clear {
- clear:both;
- height:0px;
- overflow:hidden;
-}
-.aboutLanguage {
- float:right;
- padding:0px 21px;
- font-size:11px;
- z-index:200;
- margin-top:-9px;
-}
-.legalCopy {
- margin-left:.5em;
-}
-.bar a, .bar a:link, .bar a:visited, .bar a:active {
- color:#FFFFFF;
- text-decoration:none;
-}
-.bar a:hover, .bar a:focus {
- color:#bb7a2a;
-}
-.tab {
- background-color:#0066FF;
- color:#ffffff;
- padding:8px;
- width:5em;
- font-weight:bold;
-}
-/*
-Navigation bar styles
-*/
-.bar {
- background-color:#4D7A97;
- color:#FFFFFF;
- padding:.8em .5em .4em .8em;
- height:auto;/*height:1.8em;*/
- font-size:11px;
- margin:0;
-}
-.topNav {
- background-color:#4D7A97;
- color:#FFFFFF;
- float:left;
- padding:0;
- width:100%;
- clear:right;
- height:2.8em;
- padding-top:10px;
- overflow:hidden;
- font-size:12px;
-}
-.bottomNav {
- margin-top:10px;
- background-color:#4D7A97;
- color:#FFFFFF;
- float:left;
- padding:0;
- width:100%;
- clear:right;
- height:2.8em;
- padding-top:10px;
- overflow:hidden;
- font-size:12px;
-}
-.subNav {
- background-color:#dee3e9;
- float:left;
- width:100%;
- overflow:hidden;
- font-size:12px;
-}
-.subNav div {
- clear:left;
- float:left;
- padding:0 0 5px 6px;
- text-transform:uppercase;
-}
-ul.navList, ul.subNavList {
- float:left;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.navList li{
- list-style:none;
- float:left;
- padding: 5px 6px;
- text-transform:uppercase;
-}
-ul.subNavList li{
- list-style:none;
- float:left;
-}
-.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited {
- color:#FFFFFF;
- text-decoration:none;
- text-transform:uppercase;
-}
-.topNav a:hover, .bottomNav a:hover {
- text-decoration:none;
- color:#bb7a2a;
- text-transform:uppercase;
-}
-.navBarCell1Rev {
- background-color:#F8981D;
- color:#253441;
- margin: auto 5px;
-}
-.skipNav {
- position:absolute;
- top:auto;
- left:-9999px;
- overflow:hidden;
-}
-/*
-Page header and footer styles
-*/
-.header, .footer {
- clear:both;
- margin:0 20px;
- padding:5px 0 0 0;
-}
-.indexHeader {
- margin:10px;
- position:relative;
-}
-.indexHeader span{
- margin-right:15px;
-}
-.indexHeader h1 {
- font-size:13px;
-}
-.title {
- color:#2c4557;
- margin:10px 0;
-}
-.subTitle {
- margin:5px 0 0 0;
-}
-.header ul {
- margin:0 0 15px 0;
- padding:0;
-}
-.footer ul {
- margin:20px 0 5px 0;
-}
-.header ul li, .footer ul li {
- list-style:none;
- font-size:13px;
-}
-/*
-Heading styles
-*/
-div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
- background-color:#dee3e9;
- border:1px solid #d0d9e0;
- margin:0 0 6px -8px;
- padding:7px 5px;
-}
-ul.blockList ul.blockList ul.blockList li.blockList h3 {
- background-color:#dee3e9;
- border:1px solid #d0d9e0;
- margin:0 0 6px -8px;
- padding:7px 5px;
-}
-ul.blockList ul.blockList li.blockList h3 {
- padding:0;
- margin:15px 0;
-}
-ul.blockList li.blockList h2 {
- padding:0px 0 20px 0;
-}
-/*
-Page layout container styles
-*/
-.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
- clear:both;
- padding:10px 20px;
- position:relative;
-}
-.indexContainer {
- margin:10px;
- position:relative;
- font-size:12px;
-}
-.indexContainer h2 {
- font-size:13px;
- padding:0 0 3px 0;
-}
-.indexContainer ul {
- margin:0;
- padding:0;
-}
-.indexContainer ul li {
- list-style:none;
- padding-top:2px;
-}
-.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt {
- font-size:12px;
- font-weight:bold;
- margin:10px 0 0 0;
- color:#4E4E4E;
-}
-.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
- margin:5px 0 10px 0px;
- font-size:14px;
- font-family:'DejaVu Sans Mono',monospace;
-}
-.serializedFormContainer dl.nameValue dt {
- margin-left:1px;
- font-size:1.1em;
- display:inline;
- font-weight:bold;
-}
-.serializedFormContainer dl.nameValue dd {
- margin:0 0 0 1px;
- font-size:1.1em;
- display:inline;
-}
-/*
-List styles
-*/
-ul.horizontal li {
- display:inline;
- font-size:0.9em;
-}
-ul.inheritance {
- margin:0;
- padding:0;
-}
-ul.inheritance li {
- display:inline;
- list-style:none;
-}
-ul.inheritance li ul.inheritance {
- margin-left:15px;
- padding-left:15px;
- padding-top:1px;
-}
-ul.blockList, ul.blockListLast {
- margin:10px 0 10px 0;
- padding:0;
-}
-ul.blockList li.blockList, ul.blockListLast li.blockList {
- list-style:none;
- margin-bottom:15px;
- line-height:1.4;
-}
-ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList {
- padding:0px 20px 5px 10px;
- border:1px solid #ededed;
- background-color:#f8f8f8;
-}
-ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList {
- padding:0 0 5px 8px;
- background-color:#ffffff;
- border:none;
-}
-ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
- margin-left:0;
- padding-left:0;
- padding-bottom:15px;
- border:none;
-}
-ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
- list-style:none;
- border-bottom:none;
- padding-bottom:0;
-}
-table tr td dl, table tr td dl dt, table tr td dl dd {
- margin-top:0;
- margin-bottom:1px;
-}
-/*
-Table styles
-*/
-.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary {
- width:100%;
- border-left:1px solid #EEE;
- border-right:1px solid #EEE;
- border-bottom:1px solid #EEE;
-}
-.overviewSummary, .memberSummary {
- padding:0px;
-}
-.overviewSummary caption, .memberSummary caption, .typeSummary caption,
-.useSummary caption, .constantsSummary caption, .deprecatedSummary caption {
- position:relative;
- text-align:left;
- background-repeat:no-repeat;
- color:#253441;
- font-weight:bold;
- clear:none;
- overflow:hidden;
- padding:0px;
- padding-top:10px;
- padding-left:1px;
- margin:0px;
- white-space:pre;
-}
-.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
-.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
-.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
-.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
-.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
-.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
-.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
-.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited {
- color:#FFFFFF;
-}
-.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
-.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span {
- white-space:nowrap;
- padding-top:5px;
- padding-left:12px;
- padding-right:12px;
- padding-bottom:7px;
- display:inline-block;
- float:left;
- background-color:#F8981D;
- border: none;
- height:16px;
-}
-.memberSummary caption span.activeTableTab span {
- white-space:nowrap;
- padding-top:5px;
- padding-left:12px;
- padding-right:12px;
- margin-right:3px;
- display:inline-block;
- float:left;
- background-color:#F8981D;
- height:16px;
-}
-.memberSummary caption span.tableTab span {
- white-space:nowrap;
- padding-top:5px;
- padding-left:12px;
- padding-right:12px;
- margin-right:3px;
- display:inline-block;
- float:left;
- background-color:#4D7A97;
- height:16px;
-}
-.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab {
- padding-top:0px;
- padding-left:0px;
- padding-right:0px;
- background-image:none;
- float:none;
- display:inline;
-}
-.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
-.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd {
- display:none;
- width:5px;
- position:relative;
- float:left;
- background-color:#F8981D;
-}
-.memberSummary .activeTableTab .tabEnd {
- display:none;
- width:5px;
- margin-right:3px;
- position:relative;
- float:left;
- background-color:#F8981D;
-}
-.memberSummary .tableTab .tabEnd {
- display:none;
- width:5px;
- margin-right:3px;
- position:relative;
- background-color:#4D7A97;
- float:left;
-
-}
-.overviewSummary td, .memberSummary td, .typeSummary td,
-.useSummary td, .constantsSummary td, .deprecatedSummary td {
- text-align:left;
- padding:0px 0px 12px 10px;
- width:100%;
-}
-th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th,
-td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{
- vertical-align:top;
- padding-right:0px;
- padding-top:8px;
- padding-bottom:3px;
-}
-th.colFirst, th.colLast, th.colOne, .constantsSummary th {
- background:#dee3e9;
- text-align:left;
- padding:8px 3px 3px 7px;
-}
-td.colFirst, th.colFirst {
- white-space:nowrap;
- font-size:13px;
-}
-td.colLast, th.colLast {
- font-size:13px;
-}
-td.colOne, th.colOne {
- font-size:13px;
-}
-.overviewSummary td.colFirst, .overviewSummary th.colFirst,
-.overviewSummary td.colOne, .overviewSummary th.colOne,
-.memberSummary td.colFirst, .memberSummary th.colFirst,
-.memberSummary td.colOne, .memberSummary th.colOne,
-.typeSummary td.colFirst{
- width:25%;
- vertical-align:top;
-}
-td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
- font-weight:bold;
-}
-.tableSubHeadingColor {
- background-color:#EEEEFF;
-}
-.altColor {
- background-color:#FFFFFF;
-}
-.rowColor {
- background-color:#EEEEEF;
-}
-/*
-Content styles
-*/
-.description pre {
- margin-top:0;
-}
-.deprecatedContent {
- margin:0;
- padding:10px 0;
-}
-.docSummary {
- padding:0;
-}
-
-ul.blockList ul.blockList ul.blockList li.blockList h3 {
- font-style:normal;
-}
-
-div.block {
- font-size:14px;
- font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
-}
-
-td.colLast div {
- padding-top:0px;
-}
-
-
-td.colLast a {
- padding-bottom:3px;
-}
-/*
-Formatting effect styles
-*/
-.sourceLineNo {
- color:green;
- padding:0 30px 0 0;
-}
-h1.hidden {
- visibility:hidden;
- overflow:hidden;
- font-size:10px;
-}
-.block {
- display:block;
- margin:3px 10px 2px 0px;
- color:#474747;
-}
-.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
-.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
-.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink {
- font-weight:bold;
-}
-.deprecationComment, .emphasizedPhrase, .interfaceName {
- font-style:italic;
-}
-
-div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
-div.block div.block span.interfaceName {
- font-style:normal;
-}
-
-div.contentContainer ul.blockList li.blockList h2{
- padding-bottom:0px;
-}