From 2fb2c8ad901521c0e7e1fc5b50e1c00a92ec5824 Mon Sep 17 00:00:00 2001 From: Joel Trottier-Hebert Date: Thu, 22 Mar 2018 12:19:51 -0400 Subject: [PATCH] separated docs --- docs/DeveloperGuide.md | 343 -- docs/javadoc/allclasses-frame.html | 131 - docs/javadoc/allclasses-noframe.html | 131 - docs/javadoc/constant-values.html | 835 --- docs/javadoc/deprecated-list.html | 122 - docs/javadoc/help-doc.html | 223 - docs/javadoc/index-all.html | 5087 ----------------- docs/javadoc/index.html | 74 - docs/javadoc/org/iot/dsa/DSRuntime.Timer.html | 440 -- docs/javadoc/org/iot/dsa/DSRuntime.html | 338 -- .../org/iot/dsa/dslink/DSIRequester.html | 343 -- .../org/iot/dsa/dslink/DSIResponder.html | 316 - .../dsa/dslink/DSInternalErrorException.html | 278 - .../dsa/dslink/DSInvalidPathException.html | 278 - docs/javadoc/org/iot/dsa/dslink/DSLink.html | 642 --- .../org/iot/dsa/dslink/DSLinkConfig.html | 1073 ---- .../dsa/dslink/DSLinkConnection.Listener.html | 244 - .../org/iot/dsa/dslink/DSLinkConnection.html | 599 -- .../org/iot/dsa/dslink/DSMainNode.html | 404 -- .../iot/dsa/dslink/DSPermissionException.html | 290 - .../iot/dsa/dslink/DSRequestException.html | 351 -- .../javadoc/org/iot/dsa/dslink/DSSysNode.html | 441 -- .../dsa/dslink/DSUnsupportedException.html | 290 - .../org/iot/dsa/dslink/package-frame.html | 38 - .../org/iot/dsa/dslink/package-summary.html | 246 - .../org/iot/dsa/dslink/package-tree.html | 173 - .../requester/AbstractInvokeHandler.html | 375 -- .../dslink/requester/AbstractListHandler.html | 347 -- .../requester/AbstractSubscribeHandler.html | 356 -- .../iot/dsa/dslink/requester/ErrorType.html | 378 -- .../requester/OutboundInvokeHandler.Mode.html | 355 -- .../requester/OutboundInvokeHandler.html | 388 -- .../dslink/requester/OutboundListHandler.html | 324 -- .../requester/OutboundRequestHandler.html | 251 - .../dsa/dslink/requester/OutboundStream.html | 239 - .../requester/OutboundSubscribeHandler.html | 275 - .../dslink/requester/SimpleInvokeHandler.html | 500 -- .../requester/SimpleRequestHandler.html | 353 -- .../dsa/dslink/requester/package-frame.html | 37 - .../dsa/dslink/requester/package-summary.html | 235 - .../dsa/dslink/requester/package-tree.html | 166 - .../iot/dsa/dslink/responder/ApiObject.html | 384 -- .../responder/InboundInvokeRequest.html | 203 - .../dslink/responder/InboundListRequest.html | 303 - .../dsa/dslink/responder/InboundRequest.html | 243 - .../dslink/responder/InboundSetRequest.html | 250 - .../responder/InboundSubscribeRequest.html | 277 - .../responder/OutboundListResponse.html | 245 - .../responder/SubscriptionCloseHandler.html | 224 - .../dsa/dslink/responder/package-frame.html | 27 - .../dsa/dslink/responder/package-summary.html | 192 - .../dsa/dslink/responder/package-tree.html | 146 - .../org/iot/dsa/io/AbstractReader.html | 764 --- .../org/iot/dsa/io/AbstractWriter.html | 977 ---- docs/javadoc/org/iot/dsa/io/DSBase64.html | 347 -- .../org/iot/dsa/io/DSIReader.Token.html | 464 -- docs/javadoc/org/iot/dsa/io/DSIReader.html | 471 -- docs/javadoc/org/iot/dsa/io/DSIWriter.html | 606 -- docs/javadoc/org/iot/dsa/io/NodeDecoder.html | 247 - docs/javadoc/org/iot/dsa/io/NodeEncoder.html | 257 - .../iot/dsa/io/json/AbstractJsonWriter.html | 704 --- .../org/iot/dsa/io/json/JsonAppender.html | 632 -- .../org/iot/dsa/io/json/JsonConstants.html | 265 - .../org/iot/dsa/io/json/JsonReader.html | 516 -- .../org/iot/dsa/io/json/JsonWriter.html | 626 -- .../org/iot/dsa/io/json/package-frame.html | 27 - .../org/iot/dsa/io/json/package-summary.html | 175 - .../org/iot/dsa/io/json/package-tree.html | 153 - .../javadoc/org/iot/dsa/io/package-frame.html | 33 - .../org/iot/dsa/io/package-summary.html | 216 - docs/javadoc/org/iot/dsa/io/package-tree.html | 164 - .../org/iot/dsa/logging/AsyncLogHandler.html | 479 -- .../org/iot/dsa/logging/DSILevels.html | 487 -- .../javadoc/org/iot/dsa/logging/DSLogger.html | 737 --- .../org/iot/dsa/logging/DSLogging.html | 365 -- .../org/iot/dsa/logging/FileLogHandler.html | 424 -- .../dsa/logging/PrintStreamLogHandler.html | 323 -- .../org/iot/dsa/logging/package-frame.html | 28 - .../org/iot/dsa/logging/package-summary.html | 194 - .../org/iot/dsa/logging/package-tree.html | 150 - docs/javadoc/org/iot/dsa/node/DSBool.html | 616 -- docs/javadoc/org/iot/dsa/node/DSBytes.html | 1161 ---- docs/javadoc/org/iot/dsa/node/DSDouble.html | 696 --- docs/javadoc/org/iot/dsa/node/DSElement.html | 882 --- .../org/iot/dsa/node/DSElementType.html | 429 -- docs/javadoc/org/iot/dsa/node/DSFlexEnum.html | 604 -- docs/javadoc/org/iot/dsa/node/DSFloat.html | 670 --- docs/javadoc/org/iot/dsa/node/DSGroup.html | 834 --- docs/javadoc/org/iot/dsa/node/DSIBoolean.html | 224 - docs/javadoc/org/iot/dsa/node/DSIEnum.html | 254 - .../javadoc/org/iot/dsa/node/DSIMetadata.html | 229 - docs/javadoc/org/iot/dsa/node/DSINumber.html | 355 -- docs/javadoc/org/iot/dsa/node/DSIObject.html | 262 - docs/javadoc/org/iot/dsa/node/DSIStatus.html | 224 - .../javadoc/org/iot/dsa/node/DSIStorable.html | 247 - docs/javadoc/org/iot/dsa/node/DSIValue.html | 328 -- docs/javadoc/org/iot/dsa/node/DSInfo.html | 921 --- docs/javadoc/org/iot/dsa/node/DSInt.html | 669 --- docs/javadoc/org/iot/dsa/node/DSJavaEnum.html | 589 -- docs/javadoc/org/iot/dsa/node/DSList.html | 975 ---- docs/javadoc/org/iot/dsa/node/DSLong.html | 661 --- .../javadoc/org/iot/dsa/node/DSMap.Entry.html | 288 - docs/javadoc/org/iot/dsa/node/DSMap.html | 1224 ---- docs/javadoc/org/iot/dsa/node/DSMetadata.html | 1082 ---- docs/javadoc/org/iot/dsa/node/DSNode.html | 1916 ------- docs/javadoc/org/iot/dsa/node/DSNull.html | 456 -- docs/javadoc/org/iot/dsa/node/DSPath.html | 516 -- docs/javadoc/org/iot/dsa/node/DSRegistry.html | 300 - docs/javadoc/org/iot/dsa/node/DSStatus.html | 1568 ----- docs/javadoc/org/iot/dsa/node/DSString.html | 491 -- docs/javadoc/org/iot/dsa/node/DSValue.html | 320 -- .../javadoc/org/iot/dsa/node/DSValueNode.html | 470 -- .../javadoc/org/iot/dsa/node/DSValueType.html | 430 -- .../iot/dsa/node/action/ActionInvocation.html | 376 -- .../org/iot/dsa/node/action/ActionResult.html | 253 - .../node/action/ActionSpec.ResultType.html | 488 -- .../org/iot/dsa/node/action/ActionSpec.html | 304 - .../org/iot/dsa/node/action/ActionTable.html | 258 - .../org/iot/dsa/node/action/ActionValues.html | 236 - .../org/iot/dsa/node/action/DSAction.html | 739 --- .../iot/dsa/node/action/DSActionValues.html | 338 -- .../iot/dsa/node/action/package-frame.html | 33 - .../iot/dsa/node/action/package-summary.html | 207 - .../org/iot/dsa/node/action/package-tree.html | 159 - .../org/iot/dsa/node/event/DSIEvent.html | 175 - .../org/iot/dsa/node/event/DSISubscriber.html | 283 - .../iot/dsa/node/event/DSInfoTopic.Event.html | 366 -- .../org/iot/dsa/node/event/DSInfoTopic.html | 285 - .../org/iot/dsa/node/event/DSTopic.html | 344 -- .../dsa/node/event/DSValueTopic.Event.html | 351 -- .../org/iot/dsa/node/event/DSValueTopic.html | 287 - .../org/iot/dsa/node/event/package-frame.html | 32 - .../iot/dsa/node/event/package-summary.html | 200 - .../org/iot/dsa/node/event/package-tree.html | 158 - .../org/iot/dsa/node/package-frame.html | 58 - .../org/iot/dsa/node/package-summary.html | 367 -- .../org/iot/dsa/node/package-tree.html | 200 - docs/javadoc/org/iot/dsa/package-frame.html | 21 - docs/javadoc/org/iot/dsa/package-summary.html | 157 - docs/javadoc/org/iot/dsa/package-tree.html | 136 - .../org/iot/dsa/security/DSIPassword.html | 246 - .../org/iot/dsa/security/DSKeys.Signer.html | 356 -- .../org/iot/dsa/security/DSKeys.Verifier.html | 359 -- docs/javadoc/org/iot/dsa/security/DSKeys.html | 743 --- .../org/iot/dsa/security/DSPasswordAes.html | 615 -- .../iot/dsa/security/DSPasswordSha256.html | 595 -- .../org/iot/dsa/security/DSPermission.html | 488 -- .../org/iot/dsa/security/package-frame.html | 31 - .../org/iot/dsa/security/package-summary.html | 194 - .../org/iot/dsa/security/package-tree.html | 167 - docs/javadoc/org/iot/dsa/time/DSDateTime.html | 478 -- docs/javadoc/org/iot/dsa/time/DSInterval.html | 642 --- docs/javadoc/org/iot/dsa/time/DSTime.html | 1514 ----- .../org/iot/dsa/time/package-frame.html | 25 - .../org/iot/dsa/time/package-summary.html | 165 - .../org/iot/dsa/time/package-tree.html | 152 - .../javadoc/org/iot/dsa/util/DSException.html | 494 -- docs/javadoc/org/iot/dsa/util/DSUtil.html | 295 - .../org/iot/dsa/util/package-frame.html | 24 - .../org/iot/dsa/util/package-summary.html | 159 - .../org/iot/dsa/util/package-tree.html | 148 - docs/javadoc/overview-frame.html | 33 - docs/javadoc/overview-summary.html | 198 - docs/javadoc/overview-tree.html | 354 -- docs/javadoc/package-list | 13 - docs/javadoc/script.js | 30 - docs/javadoc/serialized-form.html | 187 - docs/javadoc/stylesheet.css | 574 -- 168 files changed, 68615 deletions(-) delete mode 100644 docs/DeveloperGuide.md delete mode 100644 docs/javadoc/allclasses-frame.html delete mode 100644 docs/javadoc/allclasses-noframe.html delete mode 100644 docs/javadoc/constant-values.html delete mode 100644 docs/javadoc/deprecated-list.html delete mode 100644 docs/javadoc/help-doc.html delete mode 100644 docs/javadoc/index-all.html delete mode 100644 docs/javadoc/index.html delete mode 100644 docs/javadoc/org/iot/dsa/DSRuntime.Timer.html delete mode 100644 docs/javadoc/org/iot/dsa/DSRuntime.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSIRequester.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSIResponder.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSInternalErrorException.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSInvalidPathException.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSLink.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSLinkConfig.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.Listener.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSMainNode.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSPermissionException.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSRequestException.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSSysNode.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/DSUnsupportedException.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/AbstractInvokeHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/AbstractListHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/AbstractSubscribeHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/ErrorType.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.Mode.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/OutboundListHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/OutboundRequestHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/OutboundStream.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/OutboundSubscribeHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/SimpleInvokeHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/SimpleRequestHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/requester/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/ApiObject.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/InboundInvokeRequest.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/InboundListRequest.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/InboundRequest.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/InboundSetRequest.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/InboundSubscribeRequest.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/OutboundListResponse.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/SubscriptionCloseHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/dslink/responder/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/io/AbstractReader.html delete mode 100644 docs/javadoc/org/iot/dsa/io/AbstractWriter.html delete mode 100644 docs/javadoc/org/iot/dsa/io/DSBase64.html delete mode 100644 docs/javadoc/org/iot/dsa/io/DSIReader.Token.html delete mode 100644 docs/javadoc/org/iot/dsa/io/DSIReader.html delete mode 100644 docs/javadoc/org/iot/dsa/io/DSIWriter.html delete mode 100644 docs/javadoc/org/iot/dsa/io/NodeDecoder.html delete mode 100644 docs/javadoc/org/iot/dsa/io/NodeEncoder.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/AbstractJsonWriter.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/JsonAppender.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/JsonConstants.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/JsonReader.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/JsonWriter.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/io/json/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/io/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/io/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/io/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/AsyncLogHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/DSILevels.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/DSLogger.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/DSLogging.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/FileLogHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/PrintStreamLogHandler.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/logging/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSBool.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSBytes.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSDouble.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSElement.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSElementType.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSFlexEnum.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSFloat.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSGroup.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSIBoolean.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSIEnum.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSIMetadata.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSINumber.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSIObject.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSIStatus.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSIStorable.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSIValue.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSInfo.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSInt.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSJavaEnum.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSList.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSLong.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSMap.Entry.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSMap.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSMetadata.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSNode.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSNull.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSPath.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSRegistry.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSStatus.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSString.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSValue.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSValueNode.html delete mode 100644 docs/javadoc/org/iot/dsa/node/DSValueType.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/ActionInvocation.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/ActionResult.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/ActionSpec.ResultType.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/ActionSpec.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/ActionTable.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/ActionValues.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/DSAction.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/DSActionValues.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/node/action/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/DSIEvent.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/DSISubscriber.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.Event.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/DSTopic.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/DSValueTopic.Event.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/DSValueTopic.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/node/event/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/node/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/node/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/node/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/security/DSIPassword.html delete mode 100644 docs/javadoc/org/iot/dsa/security/DSKeys.Signer.html delete mode 100644 docs/javadoc/org/iot/dsa/security/DSKeys.Verifier.html delete mode 100644 docs/javadoc/org/iot/dsa/security/DSKeys.html delete mode 100644 docs/javadoc/org/iot/dsa/security/DSPasswordAes.html delete mode 100644 docs/javadoc/org/iot/dsa/security/DSPasswordSha256.html delete mode 100644 docs/javadoc/org/iot/dsa/security/DSPermission.html delete mode 100644 docs/javadoc/org/iot/dsa/security/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/security/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/security/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/time/DSDateTime.html delete mode 100644 docs/javadoc/org/iot/dsa/time/DSInterval.html delete mode 100644 docs/javadoc/org/iot/dsa/time/DSTime.html delete mode 100644 docs/javadoc/org/iot/dsa/time/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/time/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/time/package-tree.html delete mode 100644 docs/javadoc/org/iot/dsa/util/DSException.html delete mode 100644 docs/javadoc/org/iot/dsa/util/DSUtil.html delete mode 100644 docs/javadoc/org/iot/dsa/util/package-frame.html delete mode 100644 docs/javadoc/org/iot/dsa/util/package-summary.html delete mode 100644 docs/javadoc/org/iot/dsa/util/package-tree.html delete mode 100644 docs/javadoc/overview-frame.html delete mode 100644 docs/javadoc/overview-summary.html delete mode 100644 docs/javadoc/overview-tree.html delete mode 100644 docs/javadoc/package-list delete mode 100644 docs/javadoc/script.js delete mode 100644 docs/javadoc/serialized-form.html delete mode 100644 docs/javadoc/stylesheet.css diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md deleted file mode 100644 index cc04470c..00000000 --- a/docs/DeveloperGuide.md +++ /dev/null @@ -1,343 +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. - -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 -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 - -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 -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 254200f1..00000000 --- a/docs/javadoc/allclasses-frame.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - -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 f5b97024..00000000 --- a/docs/javadoc/allclasses-noframe.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - -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 10e0a44b..00000000 --- a/docs/javadoc/constant-values.html +++ /dev/null @@ -1,835 +0,0 @@ - - - - - -Constant Field Values (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Constant Field Values

-

Contents

- -
-
- - -

org.iot.*

- - - - - -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/deprecated-list.html b/docs/javadoc/deprecated-list.html deleted file mode 100644 index 352cf792..00000000 --- a/docs/javadoc/deprecated-list.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - -Deprecated List (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Deprecated API

-

Contents

-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/help-doc.html b/docs/javadoc/help-doc.html deleted file mode 100644 index 6f27b702..00000000 --- a/docs/javadoc/help-doc.html +++ /dev/null @@ -1,223 +0,0 @@ - - - - - -API Help (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

How This API Document Is Organized

-
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
-
-
- -This help file applies to API documentation generated using the standard doclet.
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html deleted file mode 100644 index a4bd741e..00000000 --- a/docs/javadoc/index-all.html +++ /dev/null @@ -1,5087 +0,0 @@ - - - - - -Index (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
A B C D E F G H I J K L M N O P R S T U V W  - - -

A

-
-
AbstractInvokeHandler - Class in org.iot.dsa.dslink.requester
-
-
Convenience implementation of the callback passed to the invoke method in the requester.
-
-
AbstractInvokeHandler() - Constructor for class org.iot.dsa.dslink.requester.AbstractInvokeHandler
-
 
-
AbstractJsonWriter - Class in org.iot.dsa.io.json
-
 
-
AbstractJsonWriter() - Constructor for class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
AbstractListHandler - Class in org.iot.dsa.dslink.requester
-
-
Convenience implementation of the handler passed to the invoke method in the requester.
-
-
AbstractListHandler() - Constructor for class org.iot.dsa.dslink.requester.AbstractListHandler
-
 
-
AbstractReader - Class in org.iot.dsa.io
-
-
Basic implementation of DSReader.
-
-
AbstractReader() - Constructor for class org.iot.dsa.io.AbstractReader
-
 
-
AbstractSubscribeHandler - Class in org.iot.dsa.dslink.requester
-
-
Convenience implementation of the handler passed to the subscribe method in the requester.
-
-
AbstractSubscribeHandler() - Constructor for class org.iot.dsa.dslink.requester.AbstractSubscribeHandler
-
 
-
AbstractWriter - Class in org.iot.dsa.io
-
-
Basic implementation of DSWriter.
-
-
AbstractWriter() - Constructor for class org.iot.dsa.io.AbstractWriter
-
 
-
ActionInvocation - Interface in org.iot.dsa.node.action
-
-
Encapsulates the details of an action invocation and provides the mechanism for updating and open - stream.
-
-
ActionResult - Interface in org.iot.dsa.node.action
-
-
Super interface for possible results of an action.
-
-
ActionSpec - Interface in org.iot.dsa.node.action
-
-
Defines an invokable node in the DSA model.
-
-
ActionSpec.ResultType - Enum in org.iot.dsa.node.action
-
-
Defines what the action returns.
-
-
ActionTable - Interface in org.iot.dsa.node.action
-
-
Provides access to the columns and rows of a table.
-
-
ActionValues - Interface in org.iot.dsa.node.action
-
-
Simple set of return values from an action.
-
-
add(DSElement) - Method in class org.iot.dsa.node.DSList
-
-
Adds the value and returns this.
-
-
add(boolean) - Method in class org.iot.dsa.node.DSList
-
-
Appends the primitive and returns this.
-
-
add(double) - Method in class org.iot.dsa.node.DSList
-
-
Appends the primitive and returns this.
-
-
add(long) - Method in class org.iot.dsa.node.DSList
-
-
Appends the primitive and returns this.
-
-
add(String) - Method in class org.iot.dsa.node.DSList
-
-
Appends the primitive and returns this.
-
-
add(int) - Method in class org.iot.dsa.node.DSList
-
-
Appends the primitive and returns this.
-
-
add(String, DSIObject) - Method in class org.iot.dsa.node.DSNode
-
-
Adds the named child only if the name is not already in use.
-
-
addAll(DSList) - Method in class org.iot.dsa.node.DSList
-
-
Add all elements of the argument to this list and returns this.
-
-
addDays(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addDays(int, long) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addDefaultParameter(String, DSIValue, String) - Method in class org.iot.dsa.node.action.DSAction
-
-
A convenience which calls addParameter with the same arguments, and also sets the metadata - for the default value.
-
-
addHours(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addHours(int, long) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addList() - Method in class org.iot.dsa.node.DSList
-
-
Appends a new list and returns it.
-
-
addListener(DSLinkConnection.Listener) - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
Adds a listener for connection events.
-
-
addMap() - Method in class org.iot.dsa.node.DSList
-
-
Appends a new map and returns it.
-
-
addMinutes(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addMinutes(int, long) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addMonths(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addMonths(int, long) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addNull() - Method in class org.iot.dsa.node.DSList
-
-
Appends null and returns this.
-
-
addParameter(DSMap) - Method in class org.iot.dsa.node.action.DSAction
-
-
Fully describes a parameter for method invocation.
-
-
addParameter(String, DSIValue, String) - Method in class org.iot.dsa.node.action.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) - Method in class org.iot.dsa.node.action.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) - Method in class org.iot.dsa.node.action.DSActionValues
-
-
Values must be added in the same order they were defined in the action.
-
-
addSeconds(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addSeconds(int, long) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addValueResult(DSMap) - Method in class org.iot.dsa.node.action.DSAction
-
-
Fully describes a return value when the result type is VALUES.
-
-
addValueResult(String, DSIValue) - Method in class org.iot.dsa.node.action.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) - Method in class org.iot.dsa.node.action.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) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addWeeks(int, long) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addYears(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
addYears(int, long) - Static method in class org.iot.dsa.time.DSTime
-
-
Adds or subtracts the corresponding time field, does not perform any alignment.
-
-
ADMIN - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
admin - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
admin() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
admin(Object) - Method in class org.iot.dsa.logging.DSLogger
-
 
-
admin(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
 
-
alignDay(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of the day.
-
-
alignDays(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of given interval.
-
-
alignHour(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of the hour.
-
-
alignHours(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of given interval.
-
-
alignMinute(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of the minute.
-
-
alignMinutes(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of given interval.
-
-
alignMonth(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of the month.
-
-
alignSecond(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of the second.
-
-
alignSeconds(int, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of given interval.
-
-
alignWeek(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of the week.
-
-
alignYear(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Aligns the time fields to the start of the year.
-
-
all - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
ApiObject - Interface in org.iot.dsa.dslink.responder
-
-
Can be a node, value or an action.
-
-
append(char[], int, int) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
-
Append the characters and return this.
-
-
append(char) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Append the char and return this.
-
-
append(char[], int, int) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Append the chars and return this.
-
-
append(CharSequence) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Append the chars and return this.
-
-
append(CharSequence, int, int) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Append the chars and return this.
-
-
append(CharSequence) - Method in class org.iot.dsa.io.json.JsonWriter
-
 
-
append(char) - Method in class org.iot.dsa.io.json.JsonWriter
-
 
-
append(CharSequence, int, int) - Method in class org.iot.dsa.io.json.JsonWriter
-
-
Append the chars and return this.
-
-
append(char[], int, int) - Method in class org.iot.dsa.io.json.JsonWriter
-
-
Append the chars and return this.
-
-
AsyncLogHandler - Class in org.iot.dsa.logging
-
-
Enqueues logging records which are then processed by separate thread.
-
-
AsyncLogHandler() - Constructor for class org.iot.dsa.logging.AsyncLogHandler
-
 
-
- - - -

B

-
-
beginList() - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
beginList(int) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
beginList() - Method in interface org.iot.dsa.io.DSIWriter
-
-
Start a new list and return this.
-
-
beginList(int) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Start a new list of the given size and return this.
-
-
beginMap() - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
beginMap(int) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
beginMap() - Method in interface org.iot.dsa.io.DSIWriter
-
-
Start a new map and return this.
-
-
beginMap(int) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Start a new map of the given size and return this.
-
-
BOOLEAN_RANGE - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
- - - -

C

-
-
cancel() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
Cancel execution, will not impact current running tasks and will have no effect if - already cancelled.
-
-
CFG_AUTH_TOKEN - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_BROKER_URL - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_CONNECTION_TYPE - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_KEY_FILE - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_LOG_LEVEL - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_NODE_FILE - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_READ_TIMEOUT - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_SAVE_INTERVAL - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_STABLE_DELAY - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
CFG_WS_TRANSPORT_FACTORY - Static variable in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
childAdded(ApiObject) - Method in interface org.iot.dsa.dslink.responder.InboundListRequest
-
-
The responder should call this whenever a child is added.
-
-
childCount() - Method in class org.iot.dsa.node.DSNode
-
-
The number of children.
-
-
childRemoved(ApiObject) - Method in interface org.iot.dsa.dslink.responder.InboundListRequest
-
-
The responder should call this whenever a child is removed.
-
-
clear() - Method in class org.iot.dsa.node.DSGroup
-
-
Removes all items.
-
-
clear() - Method in class org.iot.dsa.node.DSList
-
 
-
clear() - Method in class org.iot.dsa.node.DSMap
-
 
-
clear() - Method in class org.iot.dsa.node.DSMetadata
-
 
-
clear(String) - Method in class org.iot.dsa.node.DSMetadata
-
 
-
clear() - Method in class org.iot.dsa.node.DSNode
-
-
Removes non-permanent children.
-
-
clearAllRows() - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
Only use with stream and open tables, instructs the requester to clear all existing rows.
-
-
close() - Method in interface org.iot.dsa.dslink.responder.InboundListRequest
-
-
Allows the responder to forcefully close the list stream.
-
-
close(Exception) - Method in interface org.iot.dsa.dslink.responder.InboundListRequest
-
-
Allows the responder to forcefully close the list stream.
-
-
close() - Method in interface org.iot.dsa.dslink.responder.InboundSubscribeRequest
-
-
Allows the responder to forcefully terminate the subscription.
-
-
close() - Method in interface org.iot.dsa.io.DSIReader
-
-
Close the input.
-
-
close() - Method in interface org.iot.dsa.io.DSIWriter
-
-
Close the stream.
-
-
close() - Method in class org.iot.dsa.io.json.JsonAppender
-
 
-
close() - Method in class org.iot.dsa.io.json.JsonReader
-
 
-
close() - Method in class org.iot.dsa.io.json.JsonWriter
-
 
-
close() - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
Closes the PrintStream, terminates the write thread and performs houseKeeping.
-
-
close() - Static method in class org.iot.dsa.logging.DSLogging
-
-
Closes all async log handlers.
-
-
close() - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
For use with streams and open tables, will have no effect if the stream is already closed.
-
-
close(Exception) - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
Close and send and error.
-
-
closeStream() - Method in interface org.iot.dsa.dslink.requester.OutboundStream
-
-
Allows the requester to close the stream.
-
-
concat(String, String, StringBuilder) - Static method in class org.iot.dsa.node.DSPath
-
-
Concatenates the two paths into the given bucket.
-
-
CONFIG - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
CONFIG_FAULT - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, a configuration error has been indentified within DSA.
-
-
CONFIG_FAULT_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
configFault - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
contains(DSElement) - Method in class org.iot.dsa.node.DSList
-
 
-
contains(String) - Method in class org.iot.dsa.node.DSMap
-
 
-
contains(String) - Method in class org.iot.dsa.node.DSNode
-
-
Whether or not this node has a child with the given name.
-
-
copy() - Method in class org.iot.dsa.node.action.DSAction
-
 
-
copy() - Method in class org.iot.dsa.node.DSElement
-
-
If an object is mutable (list or map) then this should clone it, immutable objects can simply - return themselves.
-
-
copy() - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
copy() - Method in class org.iot.dsa.node.DSInfo
-
 
-
copy() - Method in interface org.iot.dsa.node.DSIObject
-
-
Return a copy if it makes sense, but return this otherwise.
-
-
copy() - Method in class org.iot.dsa.node.DSList
-
 
-
copy() - Method in class org.iot.dsa.node.DSMap
-
 
-
copy() - Method in class org.iot.dsa.node.DSNode
-
-
Returns a clone of this node and its subtree.
-
-
copy() - Method in class org.iot.dsa.node.DSNull
-
-
Returns this.
-
-
copy() - Method in class org.iot.dsa.node.DSValue
-
-
Returns this.
-
-
copy() - Method in class org.iot.dsa.node.event.DSTopic
-
-
Returns this.
-
-
count(long, long) - Method in enum org.iot.dsa.time.DSInterval
-
-
Returns the number of intervals for the given time range, or -1 if indeterminate.
-
-
currentTime() - Static method in class org.iot.dsa.time.DSDateTime
-
-
The current time.
-
-
- - - -

D

-
-
DBL_NAN - Static variable in interface org.iot.dsa.io.json.JsonConstants
-
-
How Double.NaN is encoded: "\\u001BNaN"
-
-
DBL_NEG_INF - Static variable in interface org.iot.dsa.io.json.JsonConstants
-
-
How Double.NEGATIVE_INFINITY is encoded: "\\u001B-Infinity"
-
-
DBL_POS_INF - Static variable in interface org.iot.dsa.io.json.JsonConstants
-
-
How Double.POSITIVE_INFINITY is encoded: "\\u001BInfinity"
-
-
DEBUG - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
debug - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
debug() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
debug(Object) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log a debug event.
-
-
debug(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log a debug event.
-
-
DECIMAL_PLACES - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
declareDefault(String, DSIObject) - Method in class org.iot.dsa.node.DSNode
-
-
Use this in the declareDefaults method to create a non-removable child.
-
-
declareDefaults() - Method in class org.iot.dsa.dslink.DSLink
-
-
Adds the save action, overrides should call super if they want this action.
-
-
declareDefaults() - Method in class org.iot.dsa.dslink.DSSysNode
-
 
-
declareDefaults() - Method in class org.iot.dsa.node.DSNode
-
-
The is only called once for each class.
-
-
decode(String) - Static method in class org.iot.dsa.io.DSBase64
-
-
Decodes a base 64 encoded string.
-
-
decode(DSIReader) - Static method in class org.iot.dsa.io.NodeDecoder
-
-
Reads a node tree from the given input.
-
-
decode(String) - Static method in class org.iot.dsa.node.DSBytes
-
 
-
decode() - Method in class org.iot.dsa.security.DSPasswordAes
-
-
Returns the decrypted password.
-
-
decode(String) - Static method in class org.iot.dsa.time.DSTime
-
-
This is a convenience that uses reuses and recycles a calendar instance to get the time in - millis.
-
-
decode(String, Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Converts a DSA encoded timestamp into a Java Calendar.
-
-
decodeKeys(String) - Static method in class org.iot.dsa.security.DSKeys
-
-
Decodes an instance that was encoded with encodeKeys().
-
-
decodeName(String) - Static method in class org.iot.dsa.node.DSPath
-
-
Un-escapes a name.
-
-
decodePath(String) - Static method in class org.iot.dsa.node.DSPath
-
-
Splits the path and decodes each individual name.
-
-
decodePrivate(byte[]) - Static method in class org.iot.dsa.security.DSKeys
-
-
Decodes the X9.63 encoding of a public key.
-
-
decodePublic(byte[]) - Static method in class org.iot.dsa.security.DSKeys
-
-
Decodes the X9.63 encoding of a public key.
-
-
decodeState(DSElement) - Method in class org.iot.dsa.node.DSInfo
-
 
-
DEFAULT - Static variable in class org.iot.dsa.dslink.requester.SimpleRequestHandler
-
-
An instance that can be used for those requests where the callbacks don't really matter.
-
-
DEFAULT - Static variable in class org.iot.dsa.node.action.DSAction
-
-
Use this when you have no-arg, no-return actions.
-
-
DEFAULT - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
DEFAULT_BACKUP_THRESHOLD - Static variable in class org.iot.dsa.logging.DSLogging
-
-
This is the threshold, not a hard limit: 10 megs by default.
-
-
DEFAULT_MAX_BACKUPS - Static variable in class org.iot.dsa.logging.DSLogging
-
-
The default number of backups to retain: 10 by default.
-
-
DEFAULT_MAX_QUEUE - Static variable in class org.iot.dsa.logging.DSLogging
-
-
Max async queue size: 2500 by default.
-
-
DESCRIPTION - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
DISABLED - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, the object has been disabled within DSA.
-
-
disabled - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
DISABLED_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
disconnect() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
Forcefully closes an open connection.
-
-
DISPLAY_NAME - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
DOWN - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, communications are down within DSA.
-
-
down - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
DOWN_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
DSAction - Class in org.iot.dsa.node.action
-
-
Fully describes an action and routes invocations to DSNode.onInvoke.
-
-
DSAction() - Constructor for class org.iot.dsa.node.action.DSAction
-
 
-
DSActionValues - Class in org.iot.dsa.node.action
-
-
This is a convenience implementation of ActionValues.
-
-
DSActionValues(DSAction) - Constructor for class org.iot.dsa.node.action.DSActionValues
-
 
-
DSBase64 - Class in org.iot.dsa.io
-
-
Thread-safe Base64 encoder and decoder.
-
-
DSBase64() - Constructor for class org.iot.dsa.io.DSBase64
-
 
-
DSBool - Class in org.iot.dsa.node
-
-
Represents a boolean value.
-
-
DSBytes - Class in org.iot.dsa.node
-
-
Byte array that gets encoded as a base64 string.
-
-
DSDateTime - Class in org.iot.dsa.time
-
-
Wrapper for Java time.
-
-
DSDouble - Class in org.iot.dsa.node
-
-
A 64 bit floating point (Java double).
-
-
DSElement - Class in org.iot.dsa.node
-
-
The primitives of the node model.
-
-
DSElement() - Constructor for class org.iot.dsa.node.DSElement
-
 
-
DSElementType - Enum in org.iot.dsa.node
-
-
The core set of elements that translate directly to a JSON type.
-
-
DSException - Exception in org.iot.dsa.util
-
-
An runtime exception that forwards most calls to the inner exception.
-
-
DSException(Throwable) - Constructor for exception org.iot.dsa.util.DSException
-
 
-
DSFlexEnum - Class in org.iot.dsa.node
-
-
An enum where the value and range can be created at runtime, primarily intended for defining - action parameters.
-
-
DSFloat - Class in org.iot.dsa.node
-
-
A Java float.
-
-
DSGroup - Class in org.iot.dsa.node
-
-
An index accessible collection of primitives.
-
-
DSGroup() - Constructor for class org.iot.dsa.node.DSGroup
-
 
-
DSIBoolean - Interface in org.iot.dsa.node
-
-
Indicates something that is/has a boolean value.
-
-
DSIEnum - Interface in org.iot.dsa.node
-
-
DSA Enum mapping.
-
-
DSIEvent - Interface in org.iot.dsa.node.event
-
-
This is an empty interface, DSTopics are allowed to define events however they wish.
-
-
DSILevels - Interface in org.iot.dsa.logging
-
 
-
DSIMetadata - Interface in org.iot.dsa.node
-
-
Nodes and values can implement this to provide meta-data about themselves.
-
-
DSInfo - Class in org.iot.dsa.node
-
-
All node children have corresponding DSInfo instances.
-
-
DSInfoTopic - Class in org.iot.dsa.node.event
-
-
This topic is for info related events on DSNodes.
-
-
DSInfoTopic.Event - Enum in org.iot.dsa.node.event
-
-
The possible events for this topic.
-
-
DSInt - Class in org.iot.dsa.node
-
-
A Java int.
-
-
DSInternalErrorException - Exception in org.iot.dsa.dslink
-
-
Indicates an unsupported method.
-
-
DSInternalErrorException() - Constructor for exception org.iot.dsa.dslink.DSInternalErrorException
-
 
-
DSInternalErrorException(String) - Constructor for exception org.iot.dsa.dslink.DSInternalErrorException
-
 
-
DSInterval - Enum in org.iot.dsa.time
-
-
Enum representing periods of time.
-
-
DSINumber - Interface in org.iot.dsa.node
-
-
Indicates something that is/has a numeric value.
-
-
DSInvalidPathException - Exception in org.iot.dsa.dslink
-
-
Indicates a request path was invalid.
-
-
DSInvalidPathException(String) - Constructor for exception org.iot.dsa.dslink.DSInvalidPathException
-
 
-
DSIObject - Interface in org.iot.dsa.node
-
-
Super class of anything found in the node tree.
-
-
DSIPassword - Interface in org.iot.dsa.security
-
-
Defines the api for verifying passwords.
-
-
DSIReader - Interface in 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 - Enum in org.iot.dsa.io
-
-
Represents the state of the reader, and determines which getter should be called next.
-
-
DSIRequester - Interface in org.iot.dsa.dslink
-
-
Interface for submitting outbound requests.
-
-
DSIResponder - Interface in org.iot.dsa.dslink
-
-
Interface for nodes in the node tree to manually handle requests.
-
-
DSIStatus - Interface in org.iot.dsa.node
-
-
Indicates something that is/has a quality.
-
-
DSIStorable - Interface in org.iot.dsa.node
-
-
Enables custom serialization for non-node values in the configuration database.
-
-
DSISubscriber - Interface in org.iot.dsa.node.event
-
-
DSISubscribers subscribe to DSTopics on DSNodes.
-
-
DSIValue - Interface in org.iot.dsa.node
-
-
How data values are represented in the node tree.
-
-
DSIWriter - Interface in org.iot.dsa.io
-
-
An encoder that can be used to encode large graphs with or without object instances.
-
-
DSJavaEnum - Class in org.iot.dsa.node
-
-
Wrapper for Java enums.
-
-
DSKeys - Class in org.iot.dsa.security
-
-
DSA public private key pair.
-
-
DSKeys(File) - Constructor for class org.iot.dsa.security.DSKeys
-
-
Creates a DSKeys object by decoding existing keys from the given file.
-
-
DSKeys(KeyPair) - Constructor for class org.iot.dsa.security.DSKeys
-
-
Creates a DSKeys object for an existing key pair.
-
-
DSKeys.Signer - Class in org.iot.dsa.security
-
-
Signs bytes.
-
-
DSKeys.Verifier - Class in org.iot.dsa.security
-
-
Verifies signatures.
-
-
DSLink - Class in org.iot.dsa.dslink
-
-
Represents an upstream connection, a node tree, and manages the lifecycle of both.
-
-
DSLink() - Constructor for class org.iot.dsa.dslink.DSLink
-
-
Use the load method to create links.
-
-
DSLinkConfig - Class in org.iot.dsa.dslink
-
-
Configuration options for starting a link.
-
-
DSLinkConfig() - Constructor for class org.iot.dsa.dslink.DSLinkConfig
-
-
This will create an empty unvalidated getConfig.
-
-
DSLinkConfig(File) - Constructor for class org.iot.dsa.dslink.DSLinkConfig
-
-
Can be use to change the working dir from the default process working dir.
-
-
DSLinkConfig(String) - Constructor for class org.iot.dsa.dslink.DSLinkConfig
-
-
Constructor for simulating a command line invocation, the argument will be split on the space - character.
-
-
DSLinkConfig(String[]) - Constructor for class org.iot.dsa.dslink.DSLinkConfig
-
-
Constructor for the arguments pass to a main method.
-
-
DSLinkConnection - Class in org.iot.dsa.dslink
-
-
Represents an upstream connection with a broker.
-
-
DSLinkConnection() - Constructor for class org.iot.dsa.dslink.DSLinkConnection
-
 
-
DSLinkConnection.Listener - Interface in org.iot.dsa.dslink
-
-
Intended for requester functionality so that requesters can know when to - start and stop making requests.
-
-
DSList - Class in org.iot.dsa.node
-
-
Indexed collection of elements.
-
-
DSList() - Constructor for class org.iot.dsa.node.DSList
-
 
-
DSLogger - Class in org.iot.dsa.logging
-
-
Adds an abstraction layer on Java Util Logging for two purposes: - - - - To use the DSA levels.
-
-
DSLogger() - Constructor for class org.iot.dsa.logging.DSLogger
-
 
-
DSLogging - Class in org.iot.dsa.logging
-
-
Static utilities for configuring the logging subsystem.
-
-
DSLong - Class in org.iot.dsa.node
-
-
A 64 bit integer (a Java long).
-
-
DSMainNode - Class in org.iot.dsa.dslink
-
-
The root DSNode that triggers a link's custom functionality .
-
-
DSMainNode() - Constructor for class org.iot.dsa.dslink.DSMainNode
-
 
-
DSMap - Class in org.iot.dsa.node
-
-
String keyed collection of elements that preserves the order of addition.
-
-
DSMap() - Constructor for class org.iot.dsa.node.DSMap
-
 
-
DSMap.Entry - Class in 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 - Class in org.iot.dsa.node
-
-
Utility fon constructing metadata maps.
-
-
DSMetadata() - Constructor for class org.iot.dsa.node.DSMetadata
-
 
-
DSMetadata(DSMap) - Constructor for class org.iot.dsa.node.DSMetadata
-
 
-
DSNode - Class in org.iot.dsa.node
-
-
The organizational unit of the node tree.
-
-
DSNode() - Constructor for class org.iot.dsa.node.DSNode
-
 
-
DSNull - Class in org.iot.dsa.node
-
-
Try not to use, it is for decoding raw json.
-
-
DSPasswordAes - Class in org.iot.dsa.security
-
-
Stores an encrypted password which can be decrypted.
-
-
DSPasswordSha256 - Class in org.iot.dsa.security
-
-
Stores and verifies passwords using a SHA-256 hash of the text.
-
-
DSPath - Class in org.iot.dsa.node
-
-
Represents a path in the node tree.
-
-
DSPath(String) - Constructor for class org.iot.dsa.node.DSPath
-
 
-
DSPermission - Enum in org.iot.dsa.security
-
-
Used to define the required permissions for various objects.
-
-
DSPermissionException - Exception in org.iot.dsa.dslink
-
-
Indicates a request has insufficient permissions.
-
-
DSPermissionException() - Constructor for exception org.iot.dsa.dslink.DSPermissionException
-
 
-
DSPermissionException(String) - Constructor for exception org.iot.dsa.dslink.DSPermissionException
-
 
-
DSRegistry - Class in org.iot.dsa.node
-
-
Static type related meta-data.
-
-
DSRegistry() - Constructor for class org.iot.dsa.node.DSRegistry
-
 
-
DSRequestException - Exception in org.iot.dsa.dslink
-
-
Indicates something was wrong with a request.
-
-
DSRequestException() - Constructor for exception org.iot.dsa.dslink.DSRequestException
-
 
-
DSRequestException(String) - Constructor for exception org.iot.dsa.dslink.DSRequestException
-
 
-
DSRuntime - Class in org.iot.dsa
-
-
DSA thread pool and timers.
-
-
DSRuntime.Timer - Class in org.iot.dsa
-
-
Can be used to inspect and cancel tasks passed to the run methods in DSRuntime.
-
-
DSStatus - Class in org.iot.dsa.node
-
-
Represent the health, quality or condition of an object.
-
-
DSString - Class in org.iot.dsa.node
-
-
String wrapper.
-
-
DSSysNode - Class in org.iot.dsa.dslink
-
-
The root of the system nodes.
-
-
DSSysNode() - Constructor for class org.iot.dsa.dslink.DSSysNode
-
 
-
DSTime - Class in org.iot.dsa.time
-
-
Misc time utility functions.
-
-
DSTopic - Class in org.iot.dsa.node.event
-
-
DSISubscribers subscribe to DSTopics on DSNodes.
-
-
DSTopic() - Constructor for class org.iot.dsa.node.event.DSTopic
-
 
-
DSUnsupportedException - Exception in org.iot.dsa.dslink
-
-
Indicates an unsupported method.
-
-
DSUnsupportedException() - Constructor for exception org.iot.dsa.dslink.DSUnsupportedException
-
 
-
DSUnsupportedException(String) - Constructor for exception org.iot.dsa.dslink.DSUnsupportedException
-
 
-
DSUtil - Class in org.iot.dsa.util
-
-
Common utilities.
-
-
DSValue - Class in org.iot.dsa.node
-
-
A convenience that provides some common default behavior.
-
-
DSValue() - Constructor for class org.iot.dsa.node.DSValue
-
 
-
DSValueNode - Class in org.iot.dsa.node
-
-
A convenience implementation of a node that is also a value.
-
-
DSValueNode() - Constructor for class org.iot.dsa.node.DSValueNode
-
 
-
DSValueTopic - Class in org.iot.dsa.node.event
-
-
This topic is for change of value events on DSNodes.
-
-
DSValueTopic.Event - Enum in org.iot.dsa.node.event
-
-
The possible events from this topic.
-
-
DSValueType - Enum in org.iot.dsa.node
-
-
These are the primitive types in the DSA protocol.
-
-
- - - -

E

-
-
EDITOR - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
EMPTY - Static variable in class org.iot.dsa.node.DSString
-
-
The string of length 0.
-
-
encode(byte[]) - Static method in class org.iot.dsa.io.DSBase64
-
-
Encodes the bytes into a single line string with no padding.
-
-
encode(byte[], int) - Static method in class org.iot.dsa.io.DSBase64
-
-
Encodes the buffer into a String with the given line length.
-
-
encode(DSIWriter, DSNode) - Static method in class org.iot.dsa.io.NodeEncoder
-
-
Writes the node tree to the given writer.
-
-
encode(byte[]) - Static method in class org.iot.dsa.node.DSBytes
-
 
-
encode(byte[]) - Static method in class org.iot.dsa.security.DSPasswordAes
-
-
Encrypts the given bytes.
-
-
encode(String) - Static method in class org.iot.dsa.security.DSPasswordAes
-
-
Encrypts the given text.
-
-
encode(byte[]) - Static method in class org.iot.dsa.security.DSPasswordSha256
-
-
SHA-256 hash of the bytes encoded as url safe base 64..
-
-
encode(String) - Static method in class org.iot.dsa.security.DSPasswordSha256
-
-
SHA-256 hash of the UTF-8 bytes, encoded as url safe base 64..
-
-
encode(long, boolean) - Static method in class org.iot.dsa.time.DSTime
-
-
Converts a Java Calendar into a DSA encoded timestamp.
-
-
encode(long, boolean, StringBuilder) - Static method in class org.iot.dsa.time.DSTime
-
-
Converts a Java Calendar into a DSA encoded timestamp.
-
-
encode(Calendar, boolean, StringBuilder) - Static method in class org.iot.dsa.time.DSTime
-
-
Converts a Java Calendar into a DSA encoded timestamp.
-
-
encodeForFiles(Calendar, StringBuilder) - Static method in class org.iot.dsa.time.DSTime
-
-
Converts a Java Calendar into a number safe for file names: YYMMDDHHMMSS.
-
-
encodeForLogs(Calendar, StringBuilder) - Static method in class org.iot.dsa.time.DSTime
-
-
Converts a Java Calendar into a shorter human readable timestamp for use in logging files.
-
-
encodeKeys() - Method in class org.iot.dsa.security.DSKeys
-
-
Encodes the key pair which can be then decoded with decodeKeys().
-
-
encodeName(String) - Static method in class org.iot.dsa.node.DSPath
-
-
Encodes a name for being in a path.
-
-
encodeName(String, StringBuilder) - Static method in class org.iot.dsa.node.DSPath
-
-
Encodes a name for being in a path.
-
-
encodeNameV1(String, StringBuilder) - Static method in class org.iot.dsa.node.DSPath
-
-
Encodes a DSA v1 name for use outside of a path.
-
-
encodePath(boolean, String...) - Static method in class org.iot.dsa.node.DSPath
-
-
Creates a properly encoded path from the given names.
-
-
encodePath(boolean, String[], int) - Static method in class org.iot.dsa.node.DSPath
-
-
Creates a properly encoded path from the given names.
-
-
encodePath(DSNode) - Static method in class org.iot.dsa.node.DSPath
-
-
Ascends the tree and encodes all the node names into a path.
-
-
encodePublic() - Method in class org.iot.dsa.security.DSKeys
-
-
X9.63 encoding of the public key.
-
-
encodePublicHashDsId() - Method in class org.iot.dsa.security.DSKeys
-
-
Base64 encoding (no padding and url safe) of the SHA256 hash of the public key.
-
-
encodeState() - Method in class org.iot.dsa.node.DSInfo
-
 
-
encodeUrl(byte[]) - Static method in class org.iot.dsa.io.DSBase64
-
-
Encodes to a URL safe base64 string.
-
-
endList() - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
endList() - Method in interface org.iot.dsa.io.DSIWriter
-
-
End the current list.
-
-
endMap() - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
endMap() - Method in interface org.iot.dsa.io.DSIWriter
-
-
End the current map.
-
-
ENUM_RANGE - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
equal(Object, Object) - Static method in class org.iot.dsa.util.DSUtil
-
-
Comparison that takes null into account; null == null.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSBool
-
 
-
equals(Object) - Method in class org.iot.dsa.node.DSBytes
-
-
True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSDouble
-
-
True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSFlexEnum
-
-
True if the argument is a DSFlexEnum and the values are equal or they are both isNull.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSFloat
-
-
True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSGroup
-
 
-
equals(Object) - Method in class org.iot.dsa.node.DSInfo
-
 
-
equals(Object) - Method in class org.iot.dsa.node.DSInt
-
-
True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSJavaEnum
-
-
True if the argument is a DSDynamicEnum and the values are equal or they are both isNull.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSLong
-
-
True if the argument is a DSINumber and the values are equal or they are both isNull.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSMap.Entry
-
 
-
equals(Object) - Method in class org.iot.dsa.node.DSMap
-
 
-
equals(Object) - Method in class org.iot.dsa.node.DSNull
-
-
True of the arg == this.
-
-
equals(Object) - Method in class org.iot.dsa.node.DSStatus
-
 
-
equals(Object) - Method in class org.iot.dsa.node.DSString
-
 
-
equals(Object) - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
equals(Object) - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
equals(Object) - Method in class org.iot.dsa.time.DSDateTime
-
 
-
equalsDefault() - Method in class org.iot.dsa.node.DSInfo
-
-
True if this proxies a default and the state and value match the default.
-
-
equalsDefaultState() - Method in class org.iot.dsa.node.DSInfo
-
-
True if the state matches the default state.
-
-
equalsDefaultType() - Method in class org.iot.dsa.node.DSInfo
-
-
True if this proxies a default and the value type matches the default.
-
-
equalsDefaultValue() - Method in class org.iot.dsa.node.DSInfo
-
-
True if this proxies a default and the value matches the default.
-
-
ERROR - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
error - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
error() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
error(Object) - Method in class org.iot.dsa.logging.DSLogger
-
 
-
error(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
 
-
ErrorType - Enum in org.iot.dsa.dslink.requester
-
 
-
- - - -

F

-
-
FALSE - Static variable in class org.iot.dsa.node.DSBool
-
 
-
FATAL - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
fatal - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
fatal() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
fatal(Object) - Method in class org.iot.dsa.logging.DSLogger
-
 
-
fatal(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
 
-
FAULT - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, an operational error (exception) has occurred within DSA.
-
-
fault - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
FAULT_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
FileLogHandler - Class in org.iot.dsa.logging
-
-
Logs records to a file.
-
-
FINE - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
fine - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
fine() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
fine(Object) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log a frequent event.
-
-
fine(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log a frequent event.
-
-
fire(DSTopic, DSIEvent, DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Notifies subscribers of the event.
-
-
fire(DSTopic, DSIEvent, DSInfo, Object...) - Method in class org.iot.dsa.node.DSNode
-
-
Notifies subscribers of the event.
-
-
first() - Method in class org.iot.dsa.node.DSGroup
-
-
Returns the item at index 0.
-
-
flush() - Method in interface org.iot.dsa.io.DSIWriter
-
-
Flush the stream.
-
-
flush() - Method in class org.iot.dsa.io.json.JsonAppender
-
 
-
flush() - Method in class org.iot.dsa.io.json.JsonWriter
-
 
-
flush() - Method in class org.iot.dsa.logging.AsyncLogHandler
-
 
-
forString(String) - Static method in enum org.iot.dsa.security.DSPermission
-
 
-
fromHex(CharSequence) - Static method in class org.iot.dsa.node.DSBytes
-
-
Converts a hex string into a byte array.
-
-
- - - -

G

-
-
generateHmacSHA256Signature(byte[], byte[]) - Static method in class org.iot.dsa.security.DSKeys
-
 
-
generateSharedSecret(byte[]) - Method in class org.iot.dsa.security.DSKeys
-
-
Uses the given public key to generate an ECDH shared secret.
-
-
generateSharedSecret(String) - Method in class org.iot.dsa.security.DSKeys
-
-
Uses the given public key to generate an ECDH shared secret.
-
-
get(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Returns the value at the given index.
-
-
get(int, boolean) - Method in class org.iot.dsa.node.DSGroup
-
-
Optional getter.
-
-
get(int, double) - Method in class org.iot.dsa.node.DSGroup
-
-
Optional getter.
-
-
get(int, int) - Method in class org.iot.dsa.node.DSGroup
-
-
Optional getter.
-
-
get(int, long) - Method in class org.iot.dsa.node.DSGroup
-
-
Optional getter.
-
-
get(int, String) - Method in class org.iot.dsa.node.DSGroup
-
-
Optional getter.
-
-
get(int) - Method in class org.iot.dsa.node.DSList
-
 
-
get(int) - Method in class org.iot.dsa.node.DSMap
-
 
-
get(String) - Method in class org.iot.dsa.node.DSMap
-
-
Returns the value for the given key.
-
-
get(String, boolean) - Method in class org.iot.dsa.node.DSMap
-
-
Optional getter, returns the provided default if the value mapped to the key is null or not - convertible.
-
-
get(String, double) - Method in class org.iot.dsa.node.DSMap
-
-
Optional getter, returns the provided default if the value mapped to the key is null.
-
-
get(String, int) - Method in class org.iot.dsa.node.DSMap
-
-
Optional getter, returns the provided default if the value mapped to the key is null or not - convertible.
-
-
get(String, long) - Method in class org.iot.dsa.node.DSMap
-
-
Optional getter, returns the provided default if the value mapped to the key is null or not - convertible.
-
-
get(String, String) - Method in class org.iot.dsa.node.DSMap
-
-
Optional getter, returns the provided default if the value mapped to the key is null.
-
-
get(String) - Method in class org.iot.dsa.node.DSNode
-
-
Returns the child value with the given name, or null.
-
-
getAction() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
The action, should only be called if isAction() returns true.
-
-
getAction() - Method in interface org.iot.dsa.node.action.ActionResult
-
-
The action that was invoked.
-
-
getAction() - Method in class org.iot.dsa.node.action.DSActionValues
-
 
-
getAction() - Method in class org.iot.dsa.node.DSInfo
-
 
-
getBackups() - Method in class org.iot.dsa.logging.FileLogHandler
-
-
Backup files for this logging, found in the same directory as the active logging.
-
-
getBit(int, int) - Static method in class org.iot.dsa.util.DSUtil
-
-
Returns true if the bit at the given index is set.
-
-
getBoolean() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getBoolean() - Method in interface org.iot.dsa.io.DSIReader
-
-
Returns the value when last() == BOOLEAN.
-
-
getBoolean(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getBoolean(String) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive getter.
-
-
getBooleanRange() - Method in class org.iot.dsa.node.DSMetadata
-
-
The boolean range, or null.
-
-
getBrokerUri() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
If not set, will look for the getConfig in dslink.json.
-
-
getBytes() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getBytes() - Method in interface org.iot.dsa.io.DSIReader
-
-
Returns the value when last() == BYTES.
-
-
getBytes() - Method in class org.iot.dsa.node.DSBytes
-
-
The raw bytes, do not modify.
-
-
getCalendar() - Static method in class org.iot.dsa.time.DSTime
-
-
Attempts to reuse a calendar instance, the timezone will be set to TimeZone.getDefault().
-
-
getCalendar(long) - Static method in class org.iot.dsa.time.DSTime
-
-
Attempts to reuse a calendar instance and sets the time in millis to the argument and the - timezone to TimeZone.getDefault().
-
-
getCause() - Method in exception org.iot.dsa.util.DSException
-
 
-
getChildren() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
Iterator of child objects, should only be called if hasChildren() returns true.
-
-
getChildren() - Method in class org.iot.dsa.node.DSInfo
-
 
-
getColumns() - Method in interface org.iot.dsa.node.action.ActionTable
-
-
Column definitions, optional but highly recommended.
-
-
getConfig() - Method in class org.iot.dsa.dslink.DSLink
-
 
-
getConfig(String, boolean) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Looks for the value in dslink.json and if not found, returns the fallback.
-
-
getConfig(String, double) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Looks for the value in dslink.json and if not found, returns the fallback.
-
-
getConfig(String, int) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Looks for the value in dslink.json and if not found, returns the fallback.
-
-
getConfig(String, long) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Looks for the value in dslink.json and if not found, returns the fallback.
-
-
getConfig(String, String) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Looks for the value in dslink.json and if not found, returns the fallback.
-
-
getConnection() - Method in class org.iot.dsa.dslink.DSLink
-
 
-
getConnection() - Method in class org.iot.dsa.dslink.DSSysNode
-
 
-
getConnectionId() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
A unique descriptive tag such as a combination of the link name and the broker host.
-
-
getDecimalPlaces() - Method in class org.iot.dsa.node.DSMetadata
-
-
The decimal precision or null.
-
-
getDecoder(Class) - Static method in class org.iot.dsa.node.DSRegistry
-
-
The instance to use for decoding.
-
-
getDefault() - Method in class org.iot.dsa.node.DSMetadata
-
-
The default value for an action parameter, or null.
-
-
getDefaultLogger() - Static method in class org.iot.dsa.logging.DSLogging
-
-
The default logger.
-
-
getDefaultObject() - Method in class org.iot.dsa.node.DSInfo
-
-
If this represents a dynamic child, this just returns the current value.
-
-
getDepth() - Method in class org.iot.dsa.io.AbstractWriter
-
-
Current depth in the tree, will be needed by writeNewLineIndent.
-
-
getDescription() - Method in class org.iot.dsa.node.DSMetadata
-
-
The description, or null.
-
-
getDetail() - Method in exception org.iot.dsa.dslink.DSRequestException
-
-
Additional information to supply to the remote endpoint.
-
-
getDisplayName() - Method in class org.iot.dsa.node.DSMetadata
-
-
The alternate display name, or null.
-
-
getDouble() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getDouble() - Method in interface org.iot.dsa.io.DSIReader
-
-
Returns the value when last() == DOUBLE.
-
-
getDouble(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getDouble(String) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive getter.
-
-
getDsaVersion() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
getDsId() - Method in class org.iot.dsa.dslink.DSLink
-
-
Returns the unique id of the connection.
-
-
getDslinkJson() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
If not set, this will attempt to open dslink.json in the working the process directory.
-
-
getEditor() - Method in class org.iot.dsa.node.DSMetadata
-
-
The editor, or null.
-
-
getElement() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getElement() - Method in interface org.iot.dsa.io.DSIReader
-
-
Returns the DSElement when last() == raw type or ROOT.
-
-
getElement() - Method in class org.iot.dsa.node.DSInfo
-
-
A convenience that casts getObject().
-
-
getElement(String) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for (DSElement) get(name).
-
-
getElementType() - Method in class org.iot.dsa.node.DSBool
-
 
-
getElementType() - Method in class org.iot.dsa.node.DSBytes
-
 
-
getElementType() - Method in class org.iot.dsa.node.DSDouble
-
 
-
getElementType() - Method in class org.iot.dsa.node.DSElement
-
-
For switch statements.
-
-
getElementType() - Method in class org.iot.dsa.node.DSList
-
 
-
getElementType() - Method in class org.iot.dsa.node.DSLong
-
 
-
getElementType() - Method in class org.iot.dsa.node.DSMap
-
 
-
getElementType() - Method in class org.iot.dsa.node.DSNull
-
 
-
getElementType() - Method in class org.iot.dsa.node.DSString
-
 
-
getEntry(int) - Method in class org.iot.dsa.node.DSMap
-
 
-
getEntry(String) - Method in class org.iot.dsa.node.DSMap
-
 
-
getEnumRange() - Method in class org.iot.dsa.node.DSMetadata
-
-
The editor, or null.
-
-
getEnums(DSList) - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
getEnums(DSList) - Method in interface org.iot.dsa.node.DSIEnum
-
-
Adds the range of possible values to the given bucket.
-
-
getEnums(DSList) - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
getFirst() - Method in class org.iot.dsa.node.DSNode
-
-
The first child, or null.
-
-
getFirstInfo() - Method in class org.iot.dsa.node.DSNode
-
-
The first child info, or null.
-
-
getFirstNodeInfo() - Method in class org.iot.dsa.node.DSNode
-
-
The info for the first child node, or null.
-
-
getFloat(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getHandler(File) - Static method in class org.iot.dsa.logging.FileLogHandler
-
-
Will return an existing handler for the given file, or create a new one.
-
-
getHelpText() - Static method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Help text for command line options.
-
-
getHouseKeepingIntervalMillis() - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
Ten seconds by default, this is a guideline more than anything else.
-
-
getInfo() - Method in class org.iot.dsa.node.DSNode
-
-
DSInfo for this node in its parent, or null if un-parented.
-
-
getInfo(String) - Method in class org.iot.dsa.node.DSNode
-
-
Returns the info for the child with the given name, or null.
-
-
getInt(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getInt(String) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive getter.
-
-
getInterval() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
The interval between runs, zero or less for no interval.
-
-
getKey() - Method in class org.iot.dsa.node.DSMap.Entry
-
 
-
getKey(int) - Method in class org.iot.dsa.node.DSMap
-
-
Returns the key at the given index.
-
-
getKeys() - Method in class org.iot.dsa.dslink.DSLink
-
-
Public / private keys of the link, used to prove identity with brokers.
-
-
getKeys() - Method in class org.iot.dsa.dslink.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() - Method in class org.iot.dsa.security.DSKeys
-
-
The public and private keys.
-
-
getLast() - Method in class org.iot.dsa.node.DSNode
-
-
The last child, or null.
-
-
getLastInfo() - Method in class org.iot.dsa.node.DSNode
-
-
The last child info, or null.
-
-
getLastPathElement() - Method in class org.iot.dsa.node.DSPath
-
 
-
getLevel() - Method in enum org.iot.dsa.security.DSPermission
-
 
-
getLink() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
The link using this connection.
-
-
getLink() - Method in class org.iot.dsa.dslink.DSMainNode
-
-
The parent link or null.
-
-
getLink() - Method in class org.iot.dsa.dslink.DSSysNode
-
 
-
getLinkName() - Method in class org.iot.dsa.dslink.DSLink
-
-
As defined in dslink.json.
-
-
getLinkName() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
getList() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getList() - Method in interface org.iot.dsa.io.DSIReader
-
-
This should only be called when last() == BEGIN_LIST and it will decodeKeys the entire - list.
-
-
getList(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getList(String) - Method in class org.iot.dsa.node.DSMap
-
-
Return the list, or null.
-
-
getLocalizedMessage() - Method in exception org.iot.dsa.util.DSException
-
 
-
getLogger(String, File) - Static method in class org.iot.dsa.logging.DSLogging
-
-
Adds a FileLogHandler to the named logger, if there isn't one already.
-
-
getLogLevel() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
If not set, will attempt to use the getConfig in dslink.json but fall back to 'info' if - necessary.
-
-
getLogName() - Method in class org.iot.dsa.dslink.DSLink
-
 
-
getLogName() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
 
-
getLogName() - Method in class org.iot.dsa.dslink.DSMainNode
-
 
-
getLogName() - Method in class org.iot.dsa.dslink.DSSysNode
-
 
-
getLogName() - Method in class org.iot.dsa.logging.DSLogger
-
-
Override point, returns the simple class name by default.
-
-
getLogName() - Method in class org.iot.dsa.node.DSNode
-
 
-
getLong() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getLong() - Method in interface org.iot.dsa.io.DSIReader
-
-
Returns the value when last() == LONG.
-
-
getLong(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getLong(String) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive getter.
-
-
getMain() - Method in class org.iot.dsa.dslink.DSLink
-
 
-
getMainType() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
The type of the root node.
-
-
getMap() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getMap() - Method in interface org.iot.dsa.io.DSIReader
-
-
This should only be called when last() == BEGIN_MAP and it will decodeKeys the entire map.
-
-
getMap(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getMap(String) - Method in class org.iot.dsa.node.DSMap
-
-
Returns the map value for the given key, or null.
-
-
getMap() - Method in class org.iot.dsa.node.DSMetadata
-
 
-
getMaxBackups() - Method in class org.iot.dsa.logging.FileLogHandler
-
-
The number of backup files to retain.
-
-
getMaxValue() - Method in class org.iot.dsa.node.DSMetadata
-
-
The max value, or null.
-
-
getMessage() - Method in exception org.iot.dsa.util.DSException
-
 
-
getMetadata(DSMap) - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
 
-
getMetadata(DSMap) - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
getMetadata(DSMap) - Method in interface org.iot.dsa.node.DSIMetadata
-
-
The entity should add any metadata about itself to the given map.
-
-
getMetadata(DSMap) - Method in class org.iot.dsa.node.DSInfo
-
 
-
getMetadata(DSMap) - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
getMetadata(DSInfo, DSMap) - Static method in class org.iot.dsa.node.DSMetadata
-
-
Fully acquires metadata about the info.
-
-
getMetadata(DSInfo, DSMap) - Method in class org.iot.dsa.node.DSNode
-
-
Override point, add any meta data for the given info to the provided bucket.
-
-
getMinValue() - Method in class org.iot.dsa.node.DSMetadata
-
-
The min value, or null.
-
-
getName() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
The display name.
-
-
getName() - Method in class org.iot.dsa.node.DSInfo
-
 
-
getName() - Method in class org.iot.dsa.node.DSMetadata
-
-
The name, or null.
-
-
getName() - Method in class org.iot.dsa.node.DSNode
-
-
Returns the name of this node in its parent, or null if un-parented.
-
-
getNode() - Method in class org.iot.dsa.node.DSInfo
-
-
A convenience that casts getObject().
-
-
getNode(String) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for (DSNode) get(name).
-
-
getNodesFile() - Method in class org.iot.dsa.dslink.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() - Method in class org.iot.dsa.node.DSInfo
-
 
-
getOut() - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
The sink for formatted messages.
-
-
getParameters() - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
The parameters supplied by the requester, or null.
-
-
getParameters() - Method in interface org.iot.dsa.node.action.ActionSpec
-
-
Returns an iterator for each parameter.
-
-
getParameters() - Method in class org.iot.dsa.node.action.DSAction
-
 
-
getParameters() - Static method in class org.iot.dsa.security.DSKeys
-
-
The AlgorithmParameterSpec for the predefined elliptic curve secp256r1.
-
-
getParams() - Method in class org.iot.dsa.dslink.requester.AbstractInvokeHandler
-
-
Returns the value passed to onInit.
-
-
getParent() - Method in class org.iot.dsa.node.DSInfo
-
 
-
getParent() - Method in class org.iot.dsa.node.DSNode
-
-
Returns the parent node, or null.
-
-
getPath() - Method in class org.iot.dsa.dslink.requester.AbstractInvokeHandler
-
-
Returns the value passed to onInit.
-
-
getPath() - Method in class org.iot.dsa.dslink.requester.AbstractListHandler
-
-
Returns the value passed to onInit.
-
-
getPath() - Method in class org.iot.dsa.dslink.requester.AbstractSubscribeHandler
-
-
Returns the value passed to onInit.
-
-
getPath() - Method in interface org.iot.dsa.dslink.responder.InboundRequest
-
-
The target of the request.
-
-
getPath() - Method in class org.iot.dsa.node.DSNode
-
-
The DSA path, properly encoded.
-
-
getPath() - Method in class org.iot.dsa.node.DSPath
-
-
The raw fully encoded path.
-
-
getPathElements() - Method in class org.iot.dsa.node.DSPath
-
-
The individual, decoded path elements.
-
-
getPermission() - Method in interface org.iot.dsa.dslink.responder.InboundSetRequest
-
-
The permission to set with.
-
-
getPermission() - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
The permission level of the invoker, should be verified against the permission level required - by the action.
-
-
getPermission() - Method in interface org.iot.dsa.node.action.ActionSpec
-
-
Minimum permission level required to invoke.
-
-
getPermission() - Method in class org.iot.dsa.node.action.DSAction
-
-
Not used.
-
-
getPlaceHolder() - Method in class org.iot.dsa.node.DSMetadata
-
-
Placeholder text for text fields, or null.
-
-
getPrivateKey() - Method in class org.iot.dsa.security.DSKeys
-
-
A convenience that casts the private key.
-
-
getPublicKey() - Method in class org.iot.dsa.security.DSKeys
-
-
A convenience that casts the public key.
-
-
getQos() - Method in class org.iot.dsa.dslink.requester.AbstractSubscribeHandler
-
-
Returns the value passed to onInit.
-
-
getRequester() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
 
-
getRequestId() - Method in interface org.iot.dsa.dslink.responder.InboundRequest
-
-
Unique ID of the request, or 0 for subscriptions.
-
-
getResult(long) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Waits for the stream to close before returning, or the timeout to occur.
-
-
getResultType() - Method in interface org.iot.dsa.node.action.ActionSpec
-
-
What the action returns.
-
-
getResultType() - Method in class org.iot.dsa.node.action.DSAction
-
 
-
getRows() - Method in interface org.iot.dsa.node.action.ActionTable
-
-
This should return an iterator for the initial set of rows, or null if there aren't any.
-
-
getRunnable() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
The runnable being managed by this timer.
-
-
getSession() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
 
-
getSignature() - Method in class org.iot.dsa.security.DSKeys.Signer
-
-
The signature for all bytes passed to the update method.
-
-
getSignatureBase64() - Method in class org.iot.dsa.security.DSKeys.Signer
-
-
The base 64 encoding of the signature for all bytes passed to the update method.
-
-
getStackTrace() - Method in exception org.iot.dsa.util.DSException
-
 
-
getStream() - Method in class org.iot.dsa.dslink.requester.AbstractInvokeHandler
-
-
Returns the value passed to onInit.
-
-
getStream() - Method in class org.iot.dsa.dslink.requester.AbstractListHandler
-
-
Returns the value passed to onInit.
-
-
getStream() - Method in class org.iot.dsa.dslink.requester.AbstractSubscribeHandler
-
-
Returns the value passed to onInit.
-
-
getString() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
getString() - Method in interface org.iot.dsa.io.DSIReader
-
-
Returns the value when last() == STRING.
-
-
getString(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Primitive getter.
-
-
getString(String) - Method in class org.iot.dsa.node.DSMap
-
-
Returns the String value for the given key, or null.
-
-
getSubscriptionId() - Method in interface org.iot.dsa.dslink.responder.InboundSubscribeRequest
-
-
Unique subscription id for this path.
-
-
getSys() - Method in class org.iot.dsa.dslink.DSLink
-
 
-
getSys() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
 
-
getTarget() - Method in interface org.iot.dsa.dslink.responder.OutboundListResponse
-
-
The object that represents the path of the request.
-
-
getThreadName() - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
Used to name the thread that processes logging records.
-
-
getThreadName() - Method in class org.iot.dsa.logging.FileLogHandler
-
 
-
getThreadName() - Method in class org.iot.dsa.logging.PrintStreamLogHandler
-
 
-
getToken() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Authentication token for the broker, this can return null.
-
-
getTransport() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
 
-
getType() - Method in class org.iot.dsa.node.DSMetadata
-
-
The type for action parameters, can be used to override types in the responder api.
-
-
getUnit() - Method in class org.iot.dsa.node.DSMetadata
-
-
Value if defined, otherwise null.
-
-
getValue() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
Value of the object, should only be called if isValue() returns true.
-
-
getValue() - Method in interface org.iot.dsa.dslink.responder.InboundSetRequest
-
-
The value to set.
-
-
getValue() - Method in class org.iot.dsa.node.DSInfo
-
-
A convenience that casts getObject().
-
-
getValue() - Method in class org.iot.dsa.node.DSMap.Entry
-
 
-
getValue(String) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for (DSIValue) get(name).
-
-
getValueChild() - Method in class org.iot.dsa.node.DSValueNode
-
-
Subclasses must store the node value in a child value and provide the info for that child - here.
-
-
getValueResults() - Method in interface org.iot.dsa.node.action.ActionSpec
-
-
This is only called for the VALUES result type.
-
-
getValueResults() - Method in class org.iot.dsa.node.action.DSAction
-
 
-
getValues() - Method in interface org.iot.dsa.node.action.ActionValues
-
 
-
getValues() - Method in class org.iot.dsa.node.action.DSActionValues
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSBool
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSBytes
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSDouble
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSElement
-
-
The DSA value type mapping.
-
-
getValueType() - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSFloat
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSInt
-
 
-
getValueType() - Method in interface org.iot.dsa.node.DSIValue
-
-
The DSA type mapping.
-
-
getValueType() - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSList
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSLong
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSMap
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSNull
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSStatus
-
-
String.
-
-
getValueType() - Method in class org.iot.dsa.node.DSString
-
 
-
getValueType() - Method in class org.iot.dsa.node.DSValueNode
-
 
-
getValueType() - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
getValueType() - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
getValueType() - Method in class org.iot.dsa.time.DSDateTime
-
-
String.
-
-
- - - -

H

-
-
hasChildren() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
True if getChildren() can be called.
-
-
hasChildren() - Method in class org.iot.dsa.node.DSInfo
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSBool
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSBytes
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSDouble
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSFloat
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSGroup
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSInfo
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSInt
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSLong
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSMap.Entry
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSMap
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSStatus
-
 
-
hashCode() - Method in class org.iot.dsa.node.DSString
-
 
-
hashCode() - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
hashCode() - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
hashCode() - Method in class org.iot.dsa.time.DSDateTime
-
 
-
hasNext() - Method in class org.iot.dsa.node.DSInfo
-
-
True if there is another info after this one.
-
-
hasParent() - Method in class org.iot.dsa.node.DSGroup
-
 
-
houseKeeping() - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
Subclass hook for activities such as rolling files and cleaning up old garbage.
-
-
houseKeeping() - Method in class org.iot.dsa.logging.FileLogHandler
-
 
-
- - - -

I

-
-
InboundInvokeRequest - Interface in org.iot.dsa.dslink.responder
-
-
See ActionInvocation for the real meat.
-
-
InboundListRequest - Interface in org.iot.dsa.dslink.responder
-
-
The details about an incoming list request passed to the responder.
-
-
InboundRequest - Interface in org.iot.dsa.dslink.responder
-
-
Common to all incoming requests.
-
-
InboundSetRequest - Interface in org.iot.dsa.dslink.responder
-
 
-
InboundSubscribeRequest - Interface in org.iot.dsa.dslink.responder
-
-
The details about an incoming subscribe request passed to the responder.
-
-
indexOf(DSElement) - Method in class org.iot.dsa.node.DSGroup
-
-
Scans the collection and returns the first index that equal the arg.
-
-
indexOf(String) - Method in class org.iot.dsa.node.DSMap
-
-
Index of the given key, or -1.
-
-
INFO - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
info - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
info() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
info(Object) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log an infrequent major lifecycle event.
-
-
info(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log an infrequent major lifecycle event.
-
-
INFO_TOPIC - Static variable in class org.iot.dsa.node.DSNode
-
 
-
init(DSLinkConfig) - Method in class org.iot.dsa.dslink.DSLink
-
-
Configures a link instance including creating the appropriate connection.
-
-
initCause(Throwable) - Method in exception org.iot.dsa.util.DSException
-
 
-
insert(int, DSList...) - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
Only use with open tables, insert the rows at the given index.
-
-
INSTANCE - Static variable in class org.iot.dsa.node.event.DSInfoTopic
-
-
The only instance of this topic.
-
-
INSTANCE - Static variable in class org.iot.dsa.node.event.DSValueTopic
-
-
The only instance of this topic.
-
-
invoke(String, DSMap, OutboundInvokeHandler) - Method in interface org.iot.dsa.dslink.DSIRequester
-
-
Submits an invoke request.
-
-
invoke(DSInfo, ActionInvocation) - Method in class org.iot.dsa.node.action.DSAction
-
-
Calls onInvoke on the proper node.
-
-
isAction() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
True if the object is an action.
-
-
isAction() - Method in class org.iot.dsa.node.DSInfo
-
 
-
isAdmin() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
Whether or not this object requires configuration permission to read/write.
-
-
isAdmin() - Method in class org.iot.dsa.node.DSInfo
-
 
-
isAutoClose() - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
True by default, whether or not to close the stream upon receiving the first result.
-
-
isBad() - Method in class org.iot.dsa.node.DSStatus
-
-
If any of the bad flags are set, or is null.
-
-
isBoolean() - Method in class org.iot.dsa.node.DSBool
-
 
-
isBoolean() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a boolean.
-
-
isBytes() - Method in class org.iot.dsa.node.DSBytes
-
 
-
isBytes(String) - Static method in class org.iot.dsa.node.DSBytes
-
-
True if the string starts with the DSA escape sequence for a base 64 encoded string.
-
-
isBytes() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a byte array.
-
-
isCancelled() - Method in class org.iot.dsa.DSRuntime.Timer
-
 
-
isClosed() - Method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
-
True if CLOSED_TABLE, VOID, or VALUES.
-
-
isConfig() - Method in enum org.iot.dsa.security.DSPermission
-
 
-
isConfigFault() - Method in class org.iot.dsa.node.DSStatus
-
-
True if the associate bit is set.
-
-
isConnected() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
True when a connection is established with the remote endpoint.
-
-
isDefaultInstance() - Method in class org.iot.dsa.node.DSNode
-
-
True if this is the default instance for the type.
-
-
isDefaultOnCopy() - Method in class org.iot.dsa.node.DSInfo
-
-
Whether or not the current value, or the default value is copied.
-
-
isDisabled() - Method in class org.iot.dsa.node.DSStatus
-
-
True if the associate bit is set.
-
-
isDouble() - Method in class org.iot.dsa.node.DSDouble
-
 
-
isDouble() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a double.
-
-
isDouble() - Method in class org.iot.dsa.node.DSFloat
-
 
-
isDouble() - Method in class org.iot.dsa.node.DSInt
-
 
-
isDouble() - Method in interface org.iot.dsa.node.DSINumber
-
-
Whether or not the object represents a double.
-
-
isDown() - Method in class org.iot.dsa.node.DSStatus
-
-
True if the associate bit is set.
-
-
isDynamic() - Method in class org.iot.dsa.node.DSInfo
-
-
Whether or not this info represents a declared default.
-
-
isEmpty() - Method in class org.iot.dsa.node.DSGroup
-
-
Returns true when childCount() == 0.
-
-
isEmpty() - Method in class org.iot.dsa.node.DSMetadata
-
 
-
isEqual(Object) - Method in class org.iot.dsa.node.action.DSAction
-
-
Defaults to the equals method.
-
-
isEqual(Object) - Method in class org.iot.dsa.node.DSElement
-
 
-
isEqual(Object) - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
isEqual(Object) - Method in class org.iot.dsa.node.DSFloat
-
 
-
isEqual(DSInfo) - Method in class org.iot.dsa.node.DSInfo
-
-
True if the flags and target object are equal (not identical if the target is a node).
-
-
isEqual(Object) - Method in class org.iot.dsa.node.DSInt
-
 
-
isEqual(Object) - Method in interface org.iot.dsa.node.DSIObject
-
-
Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
-
-
isEqual(Object) - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
isEqual(Object) - Method in class org.iot.dsa.node.DSNode
-
-
True if the argument is a node with the same children, although their order can be - different.
-
-
isEqual(Object) - Method in class org.iot.dsa.node.DSStatus
-
 
-
isEqual(Object) - Method in class org.iot.dsa.node.event.DSTopic
-
-
Only test instance equality.
-
-
isEqual(Object) - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
isEqual(Object) - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
isEqual(Object) - Method in class org.iot.dsa.time.DSDateTime
-
-
Defaults to the equals method.
-
-
isFault() - Method in class org.iot.dsa.node.DSStatus
-
-
True if the associate bit is set.
-
-
isFinished() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
True if cancelled or was a one time execution and that has finished.
-
-
isFloat() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a float.
-
-
isFloat() - Method in class org.iot.dsa.node.DSFloat
-
 
-
isFloat() - Method in class org.iot.dsa.node.DSInt
-
 
-
isFloat() - Method in interface org.iot.dsa.node.DSINumber
-
-
Whether or not the object represents a double.
-
-
isGood() - Method in class org.iot.dsa.node.DSStatus
-
-
If true, any associate object / value can be trusted.
-
-
isGreaterThan(DSPermission) - Method in enum org.iot.dsa.security.DSPermission
-
-
True if this level is higher than the given.
-
-
isGroup() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a list or map.
-
-
isGroup() - Method in class org.iot.dsa.node.DSGroup
-
 
-
isHidden() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
True if the object should ignored (not be exposed through the api).
-
-
isHidden() - Method in class org.iot.dsa.node.DSInfo
-
-
Whether or not an object is visible to clients.
-
-
isIdentical(DSInfo) - Method in class org.iot.dsa.node.DSInfo
-
-
True if the flags and target object are identical.
-
-
isIdentical(Object) - Method in class org.iot.dsa.node.DSNode
-
-
True if the argument is a node with the same children in the exact same order.
-
-
isInfinite() - Method in class org.iot.dsa.node.DSDouble
-
 
-
isInt() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents an int.
-
-
isInt() - Method in class org.iot.dsa.node.DSFloat
-
 
-
isInt() - Method in class org.iot.dsa.node.DSInt
-
 
-
isInt() - Method in interface org.iot.dsa.node.DSINumber
-
-
Whether or not the object represents an int.
-
-
isList() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a list.
-
-
isList() - Method in class org.iot.dsa.node.DSList
-
-
Returns true.
-
-
isList() - Method in enum org.iot.dsa.security.DSPermission
-
 
-
isLong() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a long.
-
-
isLong() - Method in class org.iot.dsa.node.DSFloat
-
 
-
isLong() - Method in class org.iot.dsa.node.DSInt
-
 
-
isLong() - Method in interface org.iot.dsa.node.DSINumber
-
-
Whether or not the object represents a long.
-
-
isLong() - Method in class org.iot.dsa.node.DSLong
-
 
-
isMap() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a amp.
-
-
isMap() - Method in class org.iot.dsa.node.DSMap
-
-
Returns true.
-
-
isNaN() - Method in class org.iot.dsa.node.DSDouble
-
 
-
isNode() - Method in class org.iot.dsa.node.DSInfo
-
-
Whether or not the object is a DSNode.
-
-
isNode(Object) - Static method in class org.iot.dsa.node.DSNode
-
-
Convenience for instanceof DSNode.
-
-
isNull() - Method in class org.iot.dsa.node.action.DSAction
-
-
False
-
-
isNull() - Method in class org.iot.dsa.node.DSBool
-
 
-
isNull() - Method in class org.iot.dsa.node.DSBytes
-
 
-
isNull() - Method in class org.iot.dsa.node.DSDouble
-
 
-
isNull() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents null.
-
-
isNull() - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
isNull() - Method in class org.iot.dsa.node.DSFloat
-
 
-
isNull(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Whether or not the object at the given index is null.
-
-
isNull() - Method in class org.iot.dsa.node.DSInt
-
 
-
isNull() - Method in interface org.iot.dsa.node.DSIObject
-
 
-
isNull() - Method in interface org.iot.dsa.node.DSIValue
-
-
Values should have an instance representing null.
-
-
isNull() - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
isNull() - Method in class org.iot.dsa.node.DSList
-
-
Returns false.
-
-
isNull() - Method in class org.iot.dsa.node.DSLong
-
 
-
isNull() - Method in class org.iot.dsa.node.DSMap
-
-
Returns false.
-
-
isNull(String) - Method in class org.iot.dsa.node.DSMap
-
-
Returns true if the key isn't in the map, or it's value is null.
-
-
isNull() - Method in class org.iot.dsa.node.DSNode
-
-
Returns false.
-
-
isNull() - Method in class org.iot.dsa.node.DSNull
-
-
True
-
-
isNull() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isNull() - Method in class org.iot.dsa.node.event.DSTopic
-
-
False
-
-
isNull() - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
isNull() - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
isNull() - Method in class org.iot.dsa.time.DSDateTime
-
 
-
isNumber() - Method in class org.iot.dsa.node.DSDouble
-
 
-
isNumber() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a number.
-
-
isNumber() - Method in class org.iot.dsa.node.DSLong
-
 
-
isOk() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isOpen() - Method in interface org.iot.dsa.dslink.responder.InboundListRequest
-
-
Whether or not the list stream is still open.
-
-
isOpen() - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
Whether or not response is still open.
-
-
isOpen() - Method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
-
True if OPEN_TABLE or STREAM_TABLE
-
-
isOverride() - Method in class org.iot.dsa.node.DSStatus
-
-
True if the associate bit is set.
-
-
isRead() - Method in enum org.iot.dsa.security.DSPermission
-
 
-
isReadOnly() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
True if the object is a value and cannot be written.
-
-
isReadOnly() - Method in class org.iot.dsa.node.DSInfo
-
-
Whether or not an object can be written by a client.
-
-
isRemoteConfigFault() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isRemoteDisabled() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isRemoteDown() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isRemoteFault() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isRemoteOverride() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isRemoteStale() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isRemoteUnknown() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isRequester() - Method in class org.iot.dsa.dslink.DSMainNode
-
-
Override point, returns true by default.
-
-
isResponder() - Method in class org.iot.dsa.dslink.DSMainNode
-
-
Override point, returns true by default.
-
-
isRunning() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
True when the runnable is being actually being executed.
-
-
isRunning() - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for !isStopped().
-
-
isStable() - Method in class org.iot.dsa.node.DSNode
-
-
True after stable is called, children are stable before their parents.
-
-
isStale() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isStarted() - Method in class org.iot.dsa.node.DSNode
-
-
True after start is called, children are started before their parents.
-
-
isStopped() - Method in class org.iot.dsa.node.DSNode
-
-
True after stop is called, children are stopped before their parents.
-
-
isStream() - Method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
-
True if this is the STREAM_TABLE.
-
-
isStreamOpen() - Method in interface org.iot.dsa.dslink.requester.OutboundStream
-
-
Whether or not the request is open.
-
-
isString() - Method in class org.iot.dsa.node.DSElement
-
-
Whether or not the object represents a string.
-
-
isString() - Method in class org.iot.dsa.node.DSString
-
 
-
isSubscribed() - Method in class org.iot.dsa.node.DSNode
-
-
True if there are any subscribers.
-
-
isSubscribed(DSInfo, DSTopic) - Method in class org.iot.dsa.node.DSNode
-
-
True if there are any subscriptions with the matching child and topic.
-
-
isSubscribed(DSTopic) - Method in class org.iot.dsa.node.DSNode
-
-
True if there any subscriptions for the given topic.
-
-
isTransient() - Method in class org.iot.dsa.node.DSInfo
-
-
Whether or not an object is persistent.
-
-
isUnknown() - Method in class org.iot.dsa.node.DSStatus
-
 
-
isValid(DSElement) - Method in interface org.iot.dsa.security.DSIPassword
-
-
Returns true if the give element is valid according to the backing implementation.
-
-
isValid(DSElement) - Method in class org.iot.dsa.security.DSPasswordAes
-
-
Encrypts the string value of the given element and compares against the value stored in this - object.
-
-
isValid(String) - Method in class org.iot.dsa.security.DSPasswordAes
-
-
Encrypts the given string and compares against the value stored in this object.
-
-
isValid(DSElement) - Method in class org.iot.dsa.security.DSPasswordSha256
-
-
Hashes the string value of the given element and compares against the hash stored in this - object.
-
-
isValid(String) - Method in class org.iot.dsa.security.DSPasswordSha256
-
-
Hashes the given string and compares against the value stored in this object.
-
-
isValue() - Method in interface org.iot.dsa.dslink.responder.ApiObject
-
-
True if getValue() can be called.
-
-
isValue() - Method in class org.iot.dsa.node.DSInfo
-
 
-
isValues() - Method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
 
-
isVoid() - Method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
 
-
isWrite() - Method in enum org.iot.dsa.security.DSPermission
-
 
-
isZip() - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Whether or not this is zipping the output.
-
-
iterateNodes() - Method in class org.iot.dsa.node.DSNode
-
-
Returns an info iterator of child DSNodes.
-
-
iterateValues() - Method in class org.iot.dsa.node.DSNode
-
-
Returns an info iterator of child DSIValues.
-
-
iterator() - Method in class org.iot.dsa.node.DSList
-
-
Returns an iterator that does not implement remove.
-
-
iterator() - Method in class org.iot.dsa.node.DSNode
-
-
Returns an info iterator of all children.
-
-
- - - -

J

-
-
JsonAppender - Class in org.iot.dsa.io.json
-
-
Json implementation of DSWriter intended for Appendables such as StringBuilders.
-
-
JsonAppender() - Constructor for class org.iot.dsa.io.json.JsonAppender
-
-
Be sure to call one of the setOutput methods.
-
-
JsonAppender(Appendable) - Constructor for class org.iot.dsa.io.json.JsonAppender
-
-
Will write directly to the given appendable.
-
-
JsonAppender(File) - Constructor for class org.iot.dsa.io.json.JsonAppender
-
-
Creates an underlying FileWriter.
-
-
JsonAppender(File, String) - Constructor for class org.iot.dsa.io.json.JsonAppender
-
-
Will create a zip file using the zipFileName as file name inside the zip.
-
-
JsonAppender(OutputStream) - Constructor for class org.iot.dsa.io.json.JsonAppender
-
-
Creates an underlying OutputStreamWriter.
-
-
JsonAppender(OutputStream, String) - Constructor for class org.iot.dsa.io.json.JsonAppender
-
-
Will write a zip file to the given stream.
-
-
JsonConstants - Interface in org.iot.dsa.io.json
-
-
Useful constants.
-
-
JsonReader - Class in org.iot.dsa.io.json
-
-
Json implementation of DSReader.
-
-
JsonReader() - Constructor for class org.iot.dsa.io.json.JsonReader
-
 
-
JsonReader(CharSequence) - Constructor for class org.iot.dsa.io.json.JsonReader
-
 
-
JsonReader(File) - Constructor for class org.iot.dsa.io.json.JsonReader
-
 
-
JsonReader(InputStream, String) - Constructor for class org.iot.dsa.io.json.JsonReader
-
 
-
JsonReader(Reader) - Constructor for class org.iot.dsa.io.json.JsonReader
-
 
-
JsonWriter - Class in org.iot.dsa.io.json
-
-
Json implementation of DSWriter intended for OutputStreams and Writers.
-
-
JsonWriter() - Constructor for class org.iot.dsa.io.json.JsonWriter
-
-
Be sure to call one of the setOutput methods.
-
-
JsonWriter(File) - Constructor for class org.iot.dsa.io.json.JsonWriter
-
-
Creates an underlying FileWriter.
-
-
JsonWriter(File, String) - Constructor for class org.iot.dsa.io.json.JsonWriter
-
-
Will create a zip file using the zipFileName as file name inside the zip.
-
-
JsonWriter(OutputStream) - Constructor for class org.iot.dsa.io.json.JsonWriter
-
-
Creates an underlying OutputStreamWriter.
-
-
JsonWriter(OutputStream, String) - Constructor for class org.iot.dsa.io.json.JsonWriter
-
-
Will write a zip file to the given stream.
-
-
JsonWriter(Writer) - Constructor for class org.iot.dsa.io.json.JsonWriter
-
 
-
- - - -

K

-
-
key(CharSequence) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
key(CharSequence) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a key in the current map.
-
-
keys - Variable in class org.iot.dsa.node.DSMap
-
-
For preserving order.
-
-
- - - -

L

-
-
last() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
last() - Method in interface org.iot.dsa.io.DSIReader
-
-
The last value returned from next().
-
-
last() - Method in class org.iot.dsa.node.DSGroup
-
-
Returns the item at the highest index.
-
-
lastIndexOf(DSElement) - Method in class org.iot.dsa.node.DSGroup
-
-
Scans the collection and returns the first index that equal the arg.
-
-
lastRun() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
The lastRun run or -1 if it hasn't run yet.
-
-
length() - Method in class org.iot.dsa.io.AbstractWriter
-
-
Returns 0 by default.
-
-
length() - Method in interface org.iot.dsa.io.DSIWriter
-
-
If the writer is buffering output, this returns the size of that buffer.
-
-
length() - Method in class org.iot.dsa.node.DSBytes
-
-
The number of bytes in the array.
-
-
list(String, OutboundListHandler) - Method in interface org.iot.dsa.dslink.DSIRequester
-
-
Submits a list request.
-
-
list - Variable in class org.iot.dsa.node.DSList
-
 
-
load(DSLinkConfig) - Static method in class org.iot.dsa.dslink.DSLink
-
-
Creates a link by first testing for an existing serialized database.
-
-
- - - -

M

-
-
main(String[]) - Static method in class org.iot.dsa.dslink.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) - Static method in class org.iot.dsa.node.DSElement
-
-
Creates an DSIObject representation of the primitive.
-
-
make(byte[]) - Static method in class org.iot.dsa.node.DSElement
-
-
Creates an DSIObject representation of the primitive.
-
-
make(double) - Static method in class org.iot.dsa.node.DSElement
-
-
Creates an DSIObject representation of the primitive.
-
-
make(int) - Static method in class org.iot.dsa.node.DSElement
-
-
Creates an DSIObject representation of the primitive.
-
-
make(long) - Static method in class org.iot.dsa.node.DSElement
-
-
Creates an DSIObject representation of the primitive.
-
-
make(String) - Static method in class org.iot.dsa.node.DSElement
-
-
Creates an DSIObject representation of the primitive.
-
-
makeBackup() - Method in class org.iot.dsa.logging.FileLogHandler
-
-
Only public for testing, do not call.
-
-
makeException(ErrorType, String) - Static method in enum org.iot.dsa.dslink.requester.ErrorType
-
 
-
makeMessage(Throwable) - Static method in exception org.iot.dsa.util.DSException
-
-
Attempts come up with the best description of the argument.
-
-
makeNull() - Static method in class org.iot.dsa.node.DSElement
-
-
Creates an DSIObject representation of null.
-
-
makeRuntime(Throwable) - Static method in exception org.iot.dsa.util.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 - Variable in class org.iot.dsa.node.DSMap
-
 
-
MAX_VALUE - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
millis() - Method in enum org.iot.dsa.time.DSInterval
-
-
The approximate number of ms in the interval.
-
-
MILLIS_DAY - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_FIFTEEN_MINUTES - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_FIFTEEN_SECONDS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_FIVE_MINUTES - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_FIVE_SECONDS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_FOUR_HOURS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_HOUR - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_MINUTE - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_MONTH - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_QUARTER - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_SECOND - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_SIX_HOURS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_TEN_MINUTES - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_TEN_SECONDS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_THIRTY_MINUTES - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_THIRTY_SECONDS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_THREE_HOURS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_TWELVE_HOURS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_TWENTY_MINUTES - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_TWO_HOURS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_WEEK - Static variable in class org.iot.dsa.time.DSTime
-
 
-
MILLIS_YEAR - Static variable in class org.iot.dsa.time.DSTime
-
 
-
millisToNanos(long) - Static method in class org.iot.dsa.time.DSTime
-
 
-
MIN_VALUE - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
- - - -

N

-
-
NAME - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
NANOS_IN_MS - Static variable in class org.iot.dsa.time.DSTime
-
 
-
NANOS_IN_SEC - Static variable in class org.iot.dsa.time.DSTime
-
 
-
nanosToMillis(long) - Static method in class org.iot.dsa.time.DSTime
-
 
-
newKeyPair() - Static method in class org.iot.dsa.security.DSKeys
-
-
Creates a key pair for the predefined elliptic curve secp256r1.
-
-
newSignature() - Static method in class org.iot.dsa.security.DSKeys
-
-
Returns a SHA256withECDSA signature.
-
-
newSigner() - Method in class org.iot.dsa.security.DSKeys
-
-
Creates a signer for this private key.
-
-
newVerifier() - Method in class org.iot.dsa.security.DSKeys
-
-
Creates a verifier for this public key.
-
-
next() - Method in class org.iot.dsa.io.AbstractReader
-
-
Subclasses must override this, read the next item from the stream, then call one of the - setXxx methods.
-
-
next() - Method in interface org.iot.dsa.io.DSIReader
-
-
Advances the reader to the next item and returns the token representing it's current state.
-
-
next() - Method in class org.iot.dsa.io.json.JsonReader
-
 
-
next() - Method in class org.iot.dsa.node.DSInfo
-
-
The next info in the parent node.
-
-
next(long) - Method in enum org.iot.dsa.time.DSInterval
-
-
Returns the nextRun interval for the previously aligned timestamp.
-
-
nextAction() - Method in class org.iot.dsa.node.DSInfo
-
-
The next DSInfo in the parent that is an action, or null.
-
-
nextNode() - Method in class org.iot.dsa.node.DSInfo
-
-
The next DSInfo in the parent that is a node, or null.
-
-
nextRun() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
The next scheduled time to run.
-
-
nextValue() - Method in class org.iot.dsa.node.DSInfo
-
-
The next DSInfo in the parent that is a value, or null.
-
-
NodeDecoder - Class in org.iot.dsa.io
-
-
Decodes a node (tree) that was encoded with NodeEncoder.
-
-
NodeEncoder - Class in org.iot.dsa.io
-
-
Encodes a node tree using a compact JSON schema.
-
-
NULL - Static variable in class org.iot.dsa.node.DSBool
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSBytes
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSDouble
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSFlexEnum
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSFloat
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSInt
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSJavaEnum
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSLong
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSNull
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
NULL - Static variable in class org.iot.dsa.node.DSString
-
 
-
NULL - Static variable in class org.iot.dsa.security.DSPasswordAes
-
 
-
NULL - Static variable in class org.iot.dsa.security.DSPasswordSha256
-
 
-
NULL - Static variable in class org.iot.dsa.time.DSDateTime
-
 
-
- - - -

O

-
-
off - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
OK - Static variable in class org.iot.dsa.node.DSStatus
-
-
Good, no other status applies.
-
-
ok - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
OK_OVERRIDE - Static variable in class org.iot.dsa.node.DSStatus
-
-
Good, the value is overridden within DSA.
-
-
OK_OVERRIDE_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
OK_REMOTE_OVERRIDE - Static variable in class org.iot.dsa.node.DSStatus
-
-
Good, the value is overridden outside of DSA.
-
-
OK_REMOTE_OVERRIDE_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
OK_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
okOverride - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
okRemoteOverride - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
onChildAdded(DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Called when the given child is added and in the stable state.
-
-
onChildChanged(DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Called when the given child is changed and in the stable state.
-
-
onChildChanged(DSInfo) - Method in class org.iot.dsa.node.DSValueNode
-
-
This fires the NODE_CHANGED topic when the value child changes.
-
-
onChildRemoved(DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Called when the given child is removed and in the stable state.
-
-
onClose() - Method in interface org.iot.dsa.dslink.requester.OutboundRequestHandler
-
-
Callback for when the request stream is closed, no matter how or by who.
-
-
onClose() - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Causes getResult to return.
-
-
onClose() - Method in class org.iot.dsa.dslink.requester.SimpleRequestHandler
-
-
Does nothing by default.
-
-
onClose() - Method in interface org.iot.dsa.dslink.responder.OutboundListResponse
-
-
Will be called no matter how the stream is closed.
-
-
onClose(Integer) - Method in interface org.iot.dsa.dslink.responder.SubscriptionCloseHandler
-
-
Will be called no matter how the subscription is terminated.
-
-
onClose() - Method in interface org.iot.dsa.node.action.ActionResult
-
-
Always called, whether or not the result is a stream, and no matter who closes it.
-
-
onClose() - Method in class org.iot.dsa.node.action.DSActionValues
-
-
Does nothing.
-
-
onColumns(DSList) - Method in interface org.iot.dsa.dslink.requester.OutboundInvokeHandler
-
-
Called whenever columns are received.
-
-
onColumns(DSList) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Does nothing.
-
-
onConnect(DSLinkConnection) - Method in interface org.iot.dsa.dslink.DSLinkConnection.Listener
-
-
Called asynchronously after the connection with the endpoint is opened.
-
-
onConnect() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
Called after onInitialize and before onRun.
-
-
onDisconnect(DSLinkConnection) - Method in interface org.iot.dsa.dslink.DSLinkConnection.Listener
-
-
Called synchronously after the connection with the endpoint is closed.
-
-
onDisconnect() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
Called when this network connection has been closed.
-
-
onError(ErrorType, String) - Method in interface org.iot.dsa.dslink.requester.OutboundRequestHandler
-
-
Callback for when an error is received.
-
-
onError(ErrorType, String) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Will create an exception to be thrown by getResult.
-
-
onError(ErrorType, String) - Method in class org.iot.dsa.dslink.requester.SimpleRequestHandler
-
-
Does nothing by default.
-
-
onEvent(DSTopic, DSIEvent, DSNode, DSInfo, Object...) - Method in interface org.iot.dsa.node.event.DSISubscriber
-
-
Subscription callback.
-
-
onInfoChanged(DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Called when the given info is modified and in the stable state.
-
-
onInit(String, DSMap, OutboundStream) - Method in class org.iot.dsa.dslink.requester.AbstractInvokeHandler
-
-
Sets the fields so they can be access via the corresponding getters.
-
-
onInit(String, OutboundStream) - Method in class org.iot.dsa.dslink.requester.AbstractListHandler
-
-
Sets the fields so they can be accessed with the corresponding getters.
-
-
onInit(String, int, OutboundStream) - Method in class org.iot.dsa.dslink.requester.AbstractSubscribeHandler
-
-
Sets the fields so they can be accessed via the corresponding getters.
-
-
onInit(String, DSMap, OutboundStream) - Method in interface org.iot.dsa.dslink.requester.OutboundInvokeHandler
-
-
Called by the requester before returning from the invoke method.
-
-
onInit(String, OutboundStream) - Method in interface org.iot.dsa.dslink.requester.OutboundListHandler
-
-
Called by the requester before returning from the list method.
-
-
onInit(String, int, OutboundStream) - Method in interface org.iot.dsa.dslink.requester.OutboundSubscribeHandler
-
-
Called by the requester before returning from the subscribe method.
-
-
onInitialize() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
Always called before onConnect.
-
-
onInitialized() - Method in interface org.iot.dsa.dslink.requester.OutboundListHandler
-
-
Called once the initial state of the target has been transmitted.
-
-
onInsert(int, DSList) - Method in interface org.iot.dsa.dslink.requester.OutboundInvokeHandler
-
-
Called when the given rows should be inserted at the given index.
-
-
onInsert(int, DSList) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Will result in an error since tables and streams are not supported.
-
-
onInvoke(InboundInvokeRequest) - Method in interface org.iot.dsa.dslink.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) - Method in class org.iot.dsa.dslink.DSSysNode
-
 
-
onInvoke(DSInfo, ActionInvocation) - Method in class org.iot.dsa.node.DSNode
-
-
Override point, called by the default implementation of DSAction.invoke.
-
-
onList(InboundListRequest) - Method in interface org.iot.dsa.dslink.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) - Method in interface org.iot.dsa.dslink.requester.OutboundInvokeHandler
-
-
Called whenever a mode is received.
-
-
onMode(OutboundInvokeHandler.Mode) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Does nothing.
-
-
onRemove(String) - Method in interface org.iot.dsa.dslink.requester.OutboundListHandler
-
-
Only called after onOpen(), indicates something about the target of the request has been - removed.
-
-
onReplace(int, int, DSList) - Method in interface org.iot.dsa.dslink.requester.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) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Will result in an error since tables and streams are not supported.
-
-
onRun() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
The long term management of the connection (reading and writing).
-
-
onSet(InboundSetRequest) - Method in interface org.iot.dsa.dslink.DSIResponder
-
-
The implementation should do no processing of it on the calling thread.
-
-
onSet(DSInfo, DSIValue) - Method in class org.iot.dsa.node.DSNode
-
-
Override point, called when a value being set.
-
-
onSet(DSIValue) - Method in class org.iot.dsa.node.DSNode
-
-
Override point, called only when a DSNode subclass implements DSIValue is being set.
-
-
onSet(DSIValue) - Method in class org.iot.dsa.node.DSValueNode
-
 
-
onStable() - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
Starts the connection.
-
-
onStable() - Method in class org.iot.dsa.node.DSNode
-
-
Called once this node is stable, but before stable is called on children.
-
-
onStarted() - Method in class org.iot.dsa.node.DSNode
-
-
Called once this node and its entire subtree is started.
-
-
onStopped() - Method in class org.iot.dsa.dslink.DSLink
-
 
-
onStopped() - Method in class org.iot.dsa.node.DSNode
-
-
Called once this node and its entire subtree is stopped.
-
-
onSubscribe(InboundSubscribeRequest) - Method in interface org.iot.dsa.dslink.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) - Method in class org.iot.dsa.node.DSNode
-
-
Called for every subscription.
-
-
onSubscribed() - Method in class org.iot.dsa.node.DSNode
-
-
Called when this node transitions from having no subscriptions to having a subscription of - any kind.
-
-
onSubscribed(DSTopic, DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Called when the child and topic pair transitions from having no subscriptions to have a - subscription.
-
-
onTableMeta(DSMap) - Method in interface org.iot.dsa.dslink.requester.OutboundInvokeHandler
-
-
Called whenever metadata for the entire table is received.
-
-
onTableMeta(DSMap) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
 
-
onUnsubscribe(DSTopic, DSInfo, DSISubscriber) - Method in class org.iot.dsa.node.DSNode
-
-
Called for every unsubscribe.
-
-
onUnsubscribed() - Method in class org.iot.dsa.node.DSNode
-
-
Called when this node transitions to having no subscriptions of any kind.
-
-
onUnsubscribed(DSTopic, DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Called when the child and topic pair transitions to having no subscriptions.
-
-
onUnsubscribed(DSTopic, DSNode, DSInfo) - Method in interface org.iot.dsa.node.event.DSISubscriber
-
-
Called no matter how the unsubscribe happens, whether explicitly or if the node - unsubscribes itself.
-
-
onUpdate(DSList) - Method in interface org.iot.dsa.dslink.requester.OutboundInvokeHandler
-
-
Called for every row.
-
-
onUpdate(String, DSElement) - Method in interface org.iot.dsa.dslink.requester.OutboundListHandler
-
-
Called to provide a value for node metadata, attribute or child.
-
-
onUpdate(DSDateTime, DSElement, DSStatus) - Method in interface org.iot.dsa.dslink.requester.OutboundSubscribeHandler
-
-
Subscription update mechanism.
-
-
onUpdate(DSList) - Method in class org.iot.dsa.dslink.requester.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 - Interface in org.iot.dsa.dslink.requester
-
-
Callback mechanism passed to the invoke method on DSIRequester.
-
-
OutboundInvokeHandler.Mode - Enum in org.iot.dsa.dslink.requester
-
 
-
OutboundListHandler - Interface in org.iot.dsa.dslink.requester
-
-
Callback mechanism passed to the list method on DSIRequester.
-
-
OutboundListResponse - Interface in org.iot.dsa.dslink.responder
-
-
The responder is responsible for returning this upon notification of a list request.
-
-
OutboundRequestHandler - Interface in org.iot.dsa.dslink.requester
-
-
Callbacks common to all outbound requests.
-
-
OutboundStream - Interface in org.iot.dsa.dslink.requester
-
-
Mechanism for the requester to close outbound requests.
-
-
OutboundSubscribeHandler - Interface in org.iot.dsa.dslink.requester
-
-
Callback mechanism passed to the subscribe method in the requester.
-
-
- - - -

P

-
-
parse(String[]) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Parses command line args to set the internal state of this object.
-
-
PLACEHOLDER - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
prepareParameter(DSInfo, DSMap) - Method in class org.iot.dsa.node.action.DSAction
-
-
Override point, called for each parameter as it is being sent to the requester.
-
-
prettyPrint - Variable in class org.iot.dsa.io.AbstractWriter
-
-
Subclasses can use this if applicable.
-
-
printStackTrace() - Method in exception org.iot.dsa.util.DSException
-
 
-
printStackTrace(PrintStream) - Method in exception org.iot.dsa.util.DSException
-
 
-
printStackTrace(PrintWriter) - Method in exception org.iot.dsa.util.DSException
-
 
-
PrintStreamLogHandler - Class in org.iot.dsa.logging
-
-
Async logging handler for writing to streams such as System.out.
-
-
PrintStreamLogHandler(String, PrintStream) - Constructor for class org.iot.dsa.logging.PrintStreamLogHandler
-
 
-
publish(LogRecord) - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
Enqueues the record for the write thread.
-
-
put(int, DSElement) - Method in class org.iot.dsa.node.DSList
-
-
Replaces a value and returns this.
-
-
put(int, boolean) - Method in class org.iot.dsa.node.DSList
-
-
Primitive setter, returns this.
-
-
put(int, double) - Method in class org.iot.dsa.node.DSList
-
-
Primitive setter, returns this.
-
-
put(int, int) - Method in class org.iot.dsa.node.DSList
-
-
Primitive setter, returns this.
-
-
put(int, long) - Method in class org.iot.dsa.node.DSList
-
-
Primitive setter, returns this.
-
-
put(int, String) - Method in class org.iot.dsa.node.DSList
-
-
Primitive setter, returns this.
-
-
put(String, DSElement) - Method in class org.iot.dsa.node.DSMap
-
-
Adds or replaces the value for the given key and returns this.
-
-
put(String, boolean) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive setter, returns this.
-
-
put(String, double) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive setter, returns this.
-
-
put(String, int) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive setter, returns this.
-
-
put(String, long) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive setter, returns this.
-
-
put(String, String) - Method in class org.iot.dsa.node.DSMap
-
-
Primitive setter, returns this.
-
-
put(String, Throwable) - Method in class org.iot.dsa.node.DSMap
-
-
Puts a String representing the stack trace into the map.
-
-
put(String, DSIObject) - Method in class org.iot.dsa.node.DSNode
-
-
Adds or replaces the named child.
-
-
put(String, boolean) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for put(String, DSIObject)
-
-
put(String, double) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for put(String, DSIObject)
-
-
put(String, float) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for put(String, DSIObject)
-
-
put(String, int) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for put(String, DSIObject)
-
-
put(String, long) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for put(String, DSIObject)
-
-
put(String, String) - Method in class org.iot.dsa.node.DSNode
-
-
A convenience for put(String, DSIObject)
-
-
put(DSInfo, DSIObject) - Method in class org.iot.dsa.node.DSNode
-
-
Replaces the child.
-
-
putAll(DSMap) - Method in class org.iot.dsa.node.DSMap
-
-
Adds / overwrites entries in this map with those from the given.
-
-
putList(String) - Method in class org.iot.dsa.node.DSMap
-
-
Puts a new list for given key and returns it.
-
-
putMap(String) - Method in class org.iot.dsa.node.DSMap
-
-
Puts a new map for given key and returns it.
-
-
putNull(String) - Method in class org.iot.dsa.node.DSMap
-
-
Puts a null value for given key and returns this.
-
-
- - - -

R

-
-
readDouble(byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a byte array.
-
-
readDouble(InputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a stream.
-
-
readFloat(byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a byte array.
-
-
readFloat(InputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive a stream
-
-
readInt(byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a byte array.
-
-
readInt(InputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a stream.
-
-
readLong(byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a byte array.
-
-
readLong(InputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a stream.
-
-
readShort(byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a byte array.
-
-
readShort(InputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Reads the primitive from a stream.
-
-
recycle(Calendar) - Static method in class org.iot.dsa.time.DSTime
-
-
Return a calendar instance for reuse.
-
-
registerDecoder(Class, DSIValue) - Static method in class org.iot.dsa.node.DSRegistry
-
-
DSIValues must provide an instance for decoding.
-
-
REMOTE_CONFIG_FAULT - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, a configuration error is being reported by the foreign system.
-
-
REMOTE_CONFIG_FAULT_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
REMOTE_DISABLED - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, the foreign system is reporting the object is disabled.
-
-
REMOTE_DISABLED_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
REMOTE_DOWN - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, down communications are being reported by the foreign system.
-
-
REMOTE_DOWN_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
REMOTE_FAULT - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, an operational error is being reported by the foreign system.
-
-
REMOTE_FAULT_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
REMOTE_STALE - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, a stale value is being reported by the foreign system.
-
-
REMOTE_STALE_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
REMOTE_UNKNOWN - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, the foreign system is reporting the status is unknown.
-
-
REMOTE_UNKNOWN_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
remoteConfigFault - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
remoteDisabled - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
remoteDown - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
remoteFault - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
remoteStale - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
remoteUnknown - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
remove(String, OutboundRequestHandler) - Method in interface org.iot.dsa.dslink.DSIRequester
-
-
Submits request to remove an attribute.
-
-
remove(int) - Method in class org.iot.dsa.node.DSGroup
-
-
Removes the value at the given index and returns it.
-
-
remove(int) - Method in class org.iot.dsa.node.DSList
-
 
-
remove(int) - Method in class org.iot.dsa.node.DSMap
-
 
-
remove(String) - Method in class org.iot.dsa.node.DSMap
-
-
Removes the key-value pair and returns the removed value.
-
-
remove(DSInfo) - Method in class org.iot.dsa.node.DSNode
-
-
Removes the child.
-
-
remove(String) - Method in class org.iot.dsa.node.DSNode
-
-
Remove the named child if it is contained.
-
-
removeFirst() - Method in class org.iot.dsa.node.DSGroup
-
-
Remove and return the item at index 0.
-
-
removeLast() - Method in class org.iot.dsa.node.DSGroup
-
-
Remove and return the item at the highest index.
-
-
removeListener(DSLinkConnection.Listener) - Method in class org.iot.dsa.dslink.DSLinkConnection
-
-
Removes a listener for connection events.
-
-
replace(int, int, DSList...) - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
Only use with open tables, deletes len rows starting at the given index, then inserts the - given rows in their place.
-
-
reset() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
reset() - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
reset() - Method in interface org.iot.dsa.io.DSIReader
-
-
Sets last() == ROOT.
-
-
reset() - Method in interface org.iot.dsa.io.DSIWriter
-
-
Clears the state of the writer.
-
-
reset() - Method in class org.iot.dsa.io.json.JsonAppender
-
 
-
reset() - Method in class org.iot.dsa.io.json.JsonReader
-
 
-
reset() - Method in class org.iot.dsa.io.json.JsonWriter
-
 
-
reset() - Method in class org.iot.dsa.security.DSKeys.Signer
-
-
Call to begin a new signature.
-
-
reset() - Method in class org.iot.dsa.security.DSKeys.Verifier
-
-
Call to begin a new signature.
-
-
restore(DSElement) - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
restore(DSElement) - Method in interface org.iot.dsa.node.DSIStorable
-
-
Deserialize a value from the configuration database, these will be values returned from the - store() method.
-
-
restore(DSElement) - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
restore(DSElement) - Method in class org.iot.dsa.node.DSStatus
-
 
-
restore(File) - Static method in class org.iot.dsa.security.DSKeys
-
-
Decodes a key pair that was encoded by the store method.
-
-
restore(InputStream) - Static method in class org.iot.dsa.security.DSKeys
-
-
Decodes a key pair that was encoded by the store method, does not onClose the given stream.
-
-
restore(DSElement) - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
restore(DSElement) - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
run() - Method in class org.iot.dsa.dslink.DSLink
-
-
Calls starts, waits the stableDelay, then calls stable.
-
-
run(Runnable) - Static method in class org.iot.dsa.DSRuntime
-
-
Run as soon as possible on the application's thread pool and run only once.
-
-
run(Runnable, long, long) - Static method in class org.iot.dsa.DSRuntime
-
-
Run periodically starting at the given time and repeat at the given millisecond interval.
-
-
run() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
Do not call.
-
-
runAt(Runnable, long) - Static method in class org.iot.dsa.DSRuntime
-
-
Run once at the given time.
-
-
runCount() - Method in class org.iot.dsa.DSRuntime.Timer
-
-
The number of completed runs.
-
-
runDelayed(Runnable, long) - Static method in class org.iot.dsa.DSRuntime
-
-
Run once after the given delay.
-
-
- - - -

S

-
-
save() - Method in class org.iot.dsa.dslink.DSLink
-
-
Serializes the configuration database.
-
-
send(DSList) - Method in interface org.iot.dsa.node.action.ActionInvocation
-
-
Only use with stream and open tables.
-
-
set(String, DSIValue, OutboundRequestHandler) - Method in interface org.iot.dsa.dslink.DSIRequester
-
-
Submits a set request.
-
-
set(String, DSElement) - Method in class org.iot.dsa.node.DSMetadata
-
-
Set arbitrary keys.
-
-
setAdmin(boolean) - Method in class org.iot.dsa.node.DSInfo
-
 
-
setAutoClose(boolean) - Method in class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
-
Whether or not to auto close the stream on the first update.
-
-
setBackupThreshold(int) - Method in class org.iot.dsa.logging.FileLogHandler
-
-
The file size threshold after which a logging file will be backed up and cleared.
-
-
setBeginList() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setBeginMap() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setBit(int, int, boolean) - Static method in class org.iot.dsa.util.DSUtil
-
-
Set or unset a bit at the given index.
-
-
setBooleanRange(DSList) - Method in class org.iot.dsa.node.DSMetadata
-
-
The list must be size 2 and the entries must not be null.
-
-
setBooleanRange(String, String) - Method in class org.iot.dsa.node.DSMetadata
-
-
The parameters can be null, which will result in the default text (false/true).
-
-
setBrokerUri(String) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
 
-
setConfig(String, boolean) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
setConfig(String, double) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
setConfig(String, int) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
setConfig(String, long) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
setConfig(String, String) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
-
-
setDecimalPlaces(DSLong) - Method in class org.iot.dsa.node.DSMetadata
-
 
-
setDefault(DSIValue) - Method in class org.iot.dsa.node.DSMetadata
-
-
Sets the default value only, does not set type information.
-
-
setDefaultLevel(Level) - Static method in class org.iot.dsa.logging.DSLogging
-
 
-
setDescription(String) - Method in class org.iot.dsa.node.DSMetadata
-
 
-
setDetail(String) - Method in exception org.iot.dsa.dslink.DSRequestException
-
-
Overrides the default detail which is the stack trace of this exception.
-
-
setDetail(Throwable) - Method in exception org.iot.dsa.dslink.DSRequestException
-
-
Overrides the default detail which is the stack trace of this exception.
-
-
setDisplayName(String) - Method in class org.iot.dsa.node.DSMetadata
-
 
-
setDslinkJson(DSMap) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Directly set the map without using file io.
-
-
setDslinkJson(File) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Sets the link map by file path.
-
-
setEditor(String) - Method in class org.iot.dsa.node.DSMetadata
-
-
See the EDITOR_ constants.
-
-
setEndInput() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setEndList() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setEndMap() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setEnumRange(DSList) - Method in class org.iot.dsa.node.DSMetadata
-
-
List of string values for an enum or string.
-
-
setEnumRange(String...) - Method in class org.iot.dsa.node.DSMetadata
-
-
List of string values for an enum or string.
-
-
setHidden(boolean) - Method in class org.iot.dsa.node.DSInfo
-
 
-
setInput(CharSequence) - Method in class org.iot.dsa.io.json.JsonReader
-
-
Sets the input source, resets to ROOT, and returns this.
-
-
setInput(File) - Method in class org.iot.dsa.io.json.JsonReader
-
-
Sets the input source, resets to ROOT, and returns this.
-
-
setInput(InputStream, String) - Method in class org.iot.dsa.io.json.JsonReader
-
-
Sets the input source, resets to ROOT, and returns this.
-
-
setInput(Reader) - Method in class org.iot.dsa.io.json.JsonReader
-
-
Sets the input source, resets to ROOT, and returns this.
-
-
setKeys(DSKeys) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Directly set the keys without using file io.
-
-
setKeys(File) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Sets the link keys by file path.
-
-
setLinkName(String) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Overrides dslink.json.
-
-
setLogLevel(String) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Should be one of the following (case insensitive): all, finest, finer, fine, config, info, - warning, severe, off.
-
-
setLogLevel(Level) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Overrides dslink.json.
-
-
setMainType(Class) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
The type of the root node.
-
-
setMap(DSMap) - Method in class org.iot.dsa.node.DSMetadata
-
-
Change the underlying map so the metadata instance can be reused.
-
-
setMaxBackups(int) - Method in class org.iot.dsa.logging.FileLogHandler
-
-
The default is 10.
-
-
setMaxQueueSize(int) - Method in class org.iot.dsa.logging.AsyncLogHandler
-
 
-
setMaxValue(DSElement) - Method in class org.iot.dsa.node.DSMetadata
-
-
The arg should be a number.
-
-
setMinValue(DSElement) - Method in class org.iot.dsa.node.DSMetadata
-
-
The arg should be a number.
-
-
setName(String) - Method in class org.iot.dsa.node.DSMetadata
-
 
-
setNextValue(boolean) - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setNextValue(byte[]) - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setNextValue(double) - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setNextValue(long) - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setNextValue(String) - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setNextValueNull() - Method in class org.iot.dsa.io.AbstractReader
-
 
-
setNodes(DSMainNode) - Method in class org.iot.dsa.dslink.DSLink
-
 
-
setNodesFile(File) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Overrides dslink.json.
-
-
setOut(PrintStream) - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
Sets the sink for formatted messages.
-
-
setOutput(Appendable) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Sets the sink, resets the state and returns this.
-
-
setOutput(File) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Sets the sink, resets the state and returns this.
-
-
setOutput(File, String) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Will create a zip file using the zipFileName as file name inside the zip.
-
-
setOutput(OutputStream) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Sets the sink, resets the state and returns this.
-
-
setOutput(OutputStream, String) - Method in class org.iot.dsa.io.json.JsonAppender
-
-
Will write a zip file to the given stream.
-
-
setOutput(File) - Method in class org.iot.dsa.io.json.JsonWriter
-
-
Sets the sink, resets the state and returns this.
-
-
setOutput(File, String) - Method in class org.iot.dsa.io.json.JsonWriter
-
-
Will create a zip file using the zipFileName as file name inside the zip.
-
-
setOutput(OutputStream) - Method in class org.iot.dsa.io.json.JsonWriter
-
-
Sets the sink, resets the state and returns this.
-
-
setOutput(OutputStream, String) - Method in class org.iot.dsa.io.json.JsonWriter
-
-
Will write a zip file to the given stream.
-
-
setOutput(Writer) - Method in class org.iot.dsa.io.json.JsonWriter
-
-
Sets the sink, resets the state and returns this.
-
-
setPlaceHolder(String) - Method in class org.iot.dsa.node.DSMetadata
-
-
Place holder text for text fields.
-
-
setPrettyPrint(boolean) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
setReadOnly(boolean) - Method in class org.iot.dsa.node.DSInfo
-
 
-
setResultType(ActionSpec.ResultType) - Method in class org.iot.dsa.node.action.DSAction
-
-
Returns this, it is not necessary to set the result to void.
-
-
setSaveEnabled(boolean) - Method in class org.iot.dsa.dslink.DSLink
-
-
This is a transient option intended for unit tests.
-
-
setSkipMissedIntervals(boolean) - Method in class org.iot.dsa.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) - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Overrides dslink.json.
-
-
setTransient(boolean) - Method in class org.iot.dsa.node.DSInfo
-
 
-
setType(DSIValue) - Method in class org.iot.dsa.node.DSMetadata
-
-
Sets the type and if the given is an enum, sets the enum range as well.
-
-
setType(DSValueType) - Method in class org.iot.dsa.node.DSMetadata
-
-
The type for action parameters, can be used to override types in the responder api.
-
-
setUnit(String) - Method in class org.iot.dsa.node.DSMetadata
-
-
The unit identifier.
-
-
shutdown() - Method in class org.iot.dsa.dslink.DSLink
-
-
Properly shuts down the link when a thread is executing the run method.
-
-
sign(byte[], int, int) - Method in class org.iot.dsa.security.DSKeys
-
-
A convenience that creates a signer and signs the given bytes.
-
-
Signer(PrivateKey) - Constructor for class org.iot.dsa.security.DSKeys.Signer
-
 
-
SimpleInvokeHandler - Class in org.iot.dsa.dslink.requester
-
-
Action handler for non-tables/streams.
-
-
SimpleInvokeHandler() - Constructor for class org.iot.dsa.dslink.requester.SimpleInvokeHandler
-
 
-
SimpleRequestHandler - Class in org.iot.dsa.dslink.requester
-
-
Empty callback implementations.
-
-
SimpleRequestHandler() - Constructor for class org.iot.dsa.dslink.requester.SimpleRequestHandler
-
 
-
size() - Method in class org.iot.dsa.node.DSGroup
-
-
The number of items is the group.
-
-
size() - Method in class org.iot.dsa.node.DSList
-
 
-
size() - Method in class org.iot.dsa.node.DSMap
-
 
-
splitPath(String) - Static method in class org.iot.dsa.node.DSPath
-
-
Splits the path, but does not decode any names.
-
-
stable() - Method in class org.iot.dsa.node.DSNode
-
-
Called after the entire subtree is started.
-
-
STALE - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, the value hasn't updated in a reasonable amount of time (user configurable on a per - point basis) within DSA.
-
-
stale - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
STALE_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
start() - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
This must be called for the handler to actually do anything.
-
-
start() - Method in class org.iot.dsa.node.DSNode
-
-
Sets the state to starting.
-
-
stop() - Method in class org.iot.dsa.node.DSNode
-
-
Sets the state to stopped.
-
-
store() - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
store() - Method in interface org.iot.dsa.node.DSIStorable
-
-
Serialize the value for the configuration database.
-
-
store() - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
store() - Method in class org.iot.dsa.node.DSStatus
-
 
-
store(File) - Method in class org.iot.dsa.security.DSKeys
-
-
Write the bytes from the string encoding to the given file.
-
-
store(OutputStream) - Method in class org.iot.dsa.security.DSKeys
-
-
Writes the bytes from the string encoding to the given stream, does not onClose the stream.
-
-
store() - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
store() - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
subscribe(String, int, OutboundSubscribeHandler) - Method in interface org.iot.dsa.dslink.DSIRequester
-
-
Submits a subscribe request.
-
-
subscribe(DSTopic, DSInfo, DSISubscriber) - Method in class org.iot.dsa.node.DSNode
-
-
Subscribes the child and topic.
-
-
SubscriptionCloseHandler - Interface in 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) - Static method in exception org.iot.dsa.util.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() - Method in class org.iot.dsa.time.DSDateTime
-
-
The Java time represented by this object.
-
-
toBoolean() - Method in class org.iot.dsa.node.DSBool
-
 
-
toBoolean() - Method in class org.iot.dsa.node.DSDouble
-
 
-
toBoolean() - Method in class org.iot.dsa.node.DSElement
-
-
Attempts to return a boolean value.
-
-
toBoolean() - Method in interface org.iot.dsa.node.DSIBoolean
-
 
-
toBoolean() - Method in class org.iot.dsa.node.DSLong
-
 
-
toBoolean() - Method in class org.iot.dsa.node.DSString
-
 
-
toBytes() - Method in class org.iot.dsa.node.DSBytes
-
 
-
toBytes() - Method in class org.iot.dsa.node.DSElement
-
-
Returns the raw byte array for DSBytes only, which should not be modified.
-
-
toDouble() - Method in class org.iot.dsa.node.DSBool
-
-
0 or 1.
-
-
toDouble() - Method in class org.iot.dsa.node.DSDouble
-
 
-
toDouble() - Method in class org.iot.dsa.node.DSElement
-
-
Attempts to return a double value.
-
-
toDouble() - Method in class org.iot.dsa.node.DSFloat
-
 
-
toDouble() - Method in class org.iot.dsa.node.DSInt
-
 
-
toDouble() - Method in interface org.iot.dsa.node.DSINumber
-
-
If not a double, will cast the underlying value.
-
-
toDouble() - Method in class org.iot.dsa.node.DSLong
-
 
-
toElement() - Method in class org.iot.dsa.node.DSElement
-
-
Returns this.
-
-
toElement() - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
toElement() - Method in class org.iot.dsa.node.DSFloat
-
 
-
toElement() - Method in class org.iot.dsa.node.DSInt
-
 
-
toElement() - Method in interface org.iot.dsa.node.DSIValue
-
-
The current value should convert itself to an element for DSA interop such as subscription - updates, and setting requests.
-
-
toElement() - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
toElement() - Method in class org.iot.dsa.node.DSList
-
 
-
toElement() - Method in class org.iot.dsa.node.DSMap
-
 
-
toElement() - Method in class org.iot.dsa.node.DSNull
-
-
Returns this.
-
-
toElement() - Method in class org.iot.dsa.node.DSStatus
-
 
-
toElement() - Method in class org.iot.dsa.node.DSValueNode
-
 
-
toElement() - Method in class org.iot.dsa.security.DSPasswordAes
-
-
Returns a string representing the url safe base64 encoding of the hash.
-
-
toElement() - Method in class org.iot.dsa.security.DSPasswordSha256
-
-
Returns a string representing the url safe base64 encoding of the hash.
-
-
toElement() - Method in class org.iot.dsa.time.DSDateTime
-
 
-
toEnum() - Method in class org.iot.dsa.node.DSJavaEnum
-
-
The Java enum.
-
-
toFloat() - Method in class org.iot.dsa.node.DSBool
-
-
0 or 1.
-
-
toFloat() - Method in class org.iot.dsa.node.DSDouble
-
 
-
toFloat() - Method in class org.iot.dsa.node.DSElement
-
-
Attempts to return a float value.
-
-
toFloat() - Method in class org.iot.dsa.node.DSFloat
-
 
-
toFloat() - Method in class org.iot.dsa.node.DSInt
-
 
-
toFloat() - Method in interface org.iot.dsa.node.DSINumber
-
-
If not a float, will cast the underlying value.
-
-
toFloat() - Method in class org.iot.dsa.node.DSLong
-
 
-
toGroup() - Method in class org.iot.dsa.node.DSElement
-
-
Lists and maps return themselves, everything else results in an exception.
-
-
toGroup() - Method in class org.iot.dsa.node.DSGroup
-
 
-
toHex(byte, StringBuilder) - Static method in class org.iot.dsa.node.DSBytes
-
-
Converts the bytes into a hex string.
-
-
toHex(byte[], StringBuilder) - Static method in class org.iot.dsa.node.DSBytes
-
-
Converts the bytes into a hex string.
-
-
toInt() - Method in class org.iot.dsa.node.DSBool
-
-
0 or 1.
-
-
toInt() - Method in class org.iot.dsa.node.DSDouble
-
 
-
toInt() - Method in class org.iot.dsa.node.DSElement
-
-
Attempts to return an int value.
-
-
toInt() - Method in class org.iot.dsa.node.DSFloat
-
 
-
toInt() - Method in class org.iot.dsa.node.DSInt
-
 
-
toInt() - Method in interface org.iot.dsa.node.DSINumber
-
-
If not an int, will cast the underlying value.
-
-
toInt() - Method in class org.iot.dsa.node.DSLong
-
 
-
toList() - Method in class org.iot.dsa.node.DSElement
-
-
Lists return themselves, everything else results in an exception.
-
-
toList() - Method in class org.iot.dsa.node.DSList
-
 
-
toLong() - Method in class org.iot.dsa.node.DSBool
-
-
0 or 1.
-
-
toLong() - Method in class org.iot.dsa.node.DSDouble
-
 
-
toLong() - Method in class org.iot.dsa.node.DSElement
-
-
Attempts to return a long value.
-
-
toLong() - Method in class org.iot.dsa.node.DSFloat
-
 
-
toLong() - Method in class org.iot.dsa.node.DSInt
-
 
-
toLong() - Method in interface org.iot.dsa.node.DSINumber
-
-
If not a long, will cast the underlying value.
-
-
toLong() - Method in class org.iot.dsa.node.DSLong
-
 
-
toMap() - Method in class org.iot.dsa.node.DSElement
-
-
Maps return themselves, everything else results in an exception.
-
-
toMap() - Method in class org.iot.dsa.node.DSMap
-
 
-
toNode(Object) - Static method in class org.iot.dsa.node.DSNode
-
-
A convenience that casts the argument to a node.
-
-
toNumber() - Method in class org.iot.dsa.node.DSDouble
-
 
-
toNumber() - Method in class org.iot.dsa.node.DSFloat
-
 
-
toNumber() - Method in class org.iot.dsa.node.DSInt
-
 
-
toNumber() - Method in interface org.iot.dsa.node.DSINumber
-
-
Returns the Java primitive wrapper.
-
-
toNumber() - Method in class org.iot.dsa.node.DSLong
-
 
-
toStatus() - Method in interface org.iot.dsa.node.DSIStatus
-
 
-
toStatus() - Method in class org.iot.dsa.node.DSStatus
-
 
-
toString() - Method in class org.iot.dsa.DSRuntime.Timer
-
 
-
toString() - Method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
 
-
toString() - Method in class org.iot.dsa.node.DSBool
-
 
-
toString() - Method in class org.iot.dsa.node.DSBytes
-
 
-
toString() - Method in class org.iot.dsa.node.DSDouble
-
 
-
toString() - Method in enum org.iot.dsa.node.DSElementType
-
 
-
toString() - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
toString() - Method in class org.iot.dsa.node.DSFloat
-
 
-
toString() - Method in class org.iot.dsa.node.DSGroup
-
-
Json encodes the graph, be careful.
-
-
toString() - Method in interface org.iot.dsa.node.DSIEnum
-
-
The string representation of the the enum value.
-
-
toString() - Method in class org.iot.dsa.node.DSInt
-
 
-
toString() - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
toString() - Method in class org.iot.dsa.node.DSLong
-
 
-
toString() - Method in class org.iot.dsa.node.DSNull
-
 
-
toString() - Method in class org.iot.dsa.node.DSStatus
-
 
-
toString() - Method in class org.iot.dsa.node.DSString
-
 
-
toString() - Method in class org.iot.dsa.node.DSValue
-
-
If isNull(), returns "null", otherwise returns toElement().toString()
-
-
toString() - Method in enum org.iot.dsa.node.DSValueType
-
 
-
toString() - Method in class org.iot.dsa.security.DSPasswordAes
-
 
-
toString() - Method in class org.iot.dsa.security.DSPasswordSha256
-
 
-
toString() - Method in enum org.iot.dsa.security.DSPermission
-
 
-
toString() - Method in class org.iot.dsa.time.DSDateTime
-
-
ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
-
-
toString() - Method in exception org.iot.dsa.util.DSException
-
 
-
TRACE - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
trace - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
trace() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
trace(Object) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log a trace or verbose event.
-
-
trace(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log a trace or verbose event.
-
-
trimBackups() - Method in class org.iot.dsa.logging.FileLogHandler
-
-
Only public for testing, do not call.
-
-
TRUE - Static variable in class org.iot.dsa.node.DSBool
-
 
-
TYPE - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
- - - -

U

-
-
UNIT - Static variable in class org.iot.dsa.node.DSMetadata
-
 
-
UNKNOWN - Static variable in class org.iot.dsa.node.DSStatus
-
-
Bad, the status is unknown within DSA, typically the initial state at boot.
-
-
unknown - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
UNKNOWN_STR - Static variable in class org.iot.dsa.node.DSStatus
-
 
-
unsubscribe(DSTopic, DSInfo, DSISubscriber) - Method in class org.iot.dsa.node.DSNode
-
-
Unsubscribes the tuple.
-
-
update(long, DSIValue, DSStatus) - Method in interface org.iot.dsa.dslink.responder.InboundSubscribeRequest
-
-
The responder should call this when first received and then whenever the value or status - changes.
-
-
update(byte[]) - Method in class org.iot.dsa.security.DSKeys.Signer
-
-
Update the signature with the given bytes.
-
-
update(byte[], int, int) - Method in class org.iot.dsa.security.DSKeys.Signer
-
-
Update the signature with the given bytes.
-
-
update(byte[]) - Method in class org.iot.dsa.security.DSKeys.Verifier
-
-
Update the signature with the given bytes.
-
-
update(byte[], int, int) - Method in class org.iot.dsa.security.DSKeys.Verifier
-
-
Update the signature with the given bytes.
-
-
UTF8 - Static variable in class org.iot.dsa.node.DSString
-
-
The standard UTF8 charset, can be used with string.getBytes(Charset).
-
-
- - - -

V

-
-
valBoolean - Variable in class org.iot.dsa.io.AbstractReader
-
 
-
valBytes - Variable in class org.iot.dsa.io.AbstractReader
-
 
-
validate(byte[]) - Method in class org.iot.dsa.security.DSKeys.Verifier
-
-
Returns true if the given signature is valid for the bytes passed to update.
-
-
validate(String) - Method in class org.iot.dsa.security.DSKeys.Verifier
-
-
Returns true if the given base 64 encoded signature is valid for the bytes passed to - update.
-
-
validateChild(DSIObject) - Method in class org.iot.dsa.node.DSNode
-
-
Override point, throw a meaningful IllegalArgumentException if the child is not allowed
-
-
validateParent(DSNode) - Method in class org.iot.dsa.dslink.DSMainNode
-
-
The parent must be a DSLink instance.
-
-
validateParent(DSNode) - Method in class org.iot.dsa.dslink.DSSysNode
-
 
-
validateParent(DSNode) - Method in class org.iot.dsa.node.DSNode
-
-
Override point, throw a meaningful IllegalArgumentException if the parent is not allowed
-
-
valLong - Variable in class org.iot.dsa.io.AbstractReader
-
 
-
valReal - Variable in class org.iot.dsa.io.AbstractReader
-
 
-
valString - Variable in class org.iot.dsa.io.AbstractReader
-
 
-
value(DSElement) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
value(boolean) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
value(byte[]) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
value(double) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
value(int) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
value(long) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
value(String) - Method in class org.iot.dsa.io.AbstractWriter
-
 
-
value(DSElement) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a value to the map or list.
-
-
value(boolean) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a value to the map or list.
-
-
value(byte[]) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a value to the map or list.
-
-
value(double) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a value to the map or list.
-
-
value(int) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a value to the map or list.
-
-
value(long) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a value to the map or list.
-
-
value(String) - Method in interface org.iot.dsa.io.DSIWriter
-
-
Write a value to the map or list.
-
-
value(DSElement) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
VALUE_TOPIC - Static variable in class org.iot.dsa.node.DSNode
-
 
-
valueOf(String) - Static method in enum org.iot.dsa.dslink.requester.ErrorType
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum org.iot.dsa.dslink.requester.OutboundInvokeHandler.Mode
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum org.iot.dsa.io.DSIReader.Token
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(boolean) - Static method in class org.iot.dsa.node.DSBool
-
-
Will return either TRUE or FALSE.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSBool
-
 
-
valueOf(String) - Static method in class org.iot.dsa.node.DSBool
-
-
Will return NULL, TRUE or FALSE.
-
-
valueOf(byte[]) - Static method in class org.iot.dsa.node.DSBytes
-
 
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSBytes
-
 
-
valueOf(String) - Static method in class org.iot.dsa.node.DSBytes
-
-
Decodes a base64 encoded byte array.
-
-
valueOf(double) - Static method in class org.iot.dsa.node.DSDouble
-
-
Attempts to reuse some common values before creating a new instance.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSDouble
-
 
-
valueOf(String) - Static method in class org.iot.dsa.node.DSDouble
-
-
Checks for null, then uses Double.parseDouble()
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSElement
-
-
Returns the argument.
-
-
valueOf(String) - Static method in enum org.iot.dsa.node.DSElementType
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSFlexEnum
-
 
-
valueOf(String, DSList) - Static method in class org.iot.dsa.node.DSFlexEnum
-
-
Creates a enum representing the given value and range.
-
-
valueOf(String) - Method in class org.iot.dsa.node.DSFlexEnum
-
-
Creates a new enum for the given value using the range from this instance.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSFloat
-
 
-
valueOf(float) - Static method in class org.iot.dsa.node.DSFloat
-
-
Attempts to reuse some common values before creating a new instance.
-
-
valueOf(String) - Static method in class org.iot.dsa.node.DSFloat
-
-
Checks for null, then uses Float.parseFloat()
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSInt
-
 
-
valueOf(int) - Static method in class org.iot.dsa.node.DSInt
-
-
Attempts to reuse some common values before creating a new instance.
-
-
valueOf(String) - Static method in class org.iot.dsa.node.DSInt
-
-
Checks for null, then uses Float.parseFloat()
-
-
valueOf(DSElement) - Method in interface org.iot.dsa.node.DSIValue
-
-
This should convert an element transmitted over DSA, such as subscription updates or set - requests.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
valueOf(Enum) - Static method in class org.iot.dsa.node.DSJavaEnum
-
-
Creates an enum for the given value (and it's range).
-
-
valueOf(String) - Method in class org.iot.dsa.node.DSJavaEnum
-
 
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSList
-
 
-
valueOf(DSElement...) - Static method in class org.iot.dsa.node.DSList
-
 
-
valueOf(Double...) - Static method in class org.iot.dsa.node.DSList
-
 
-
valueOf(Long...) - Static method in class org.iot.dsa.node.DSList
-
 
-
valueOf(String...) - Static method in class org.iot.dsa.node.DSList
-
 
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSLong
-
-
Returns this.
-
-
valueOf(long) - Static method in class org.iot.dsa.node.DSLong
-
-
Attempts to reuse some common values before creating a new instance.
-
-
valueOf(String) - Static method in class org.iot.dsa.node.DSLong
-
-
Checks for null, then uses Float.parseFloat()
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSMap
-
 
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSNull
-
-
Returns this.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSStatus
-
 
-
valueOf(String) - Static method in class org.iot.dsa.node.DSStatus
-
 
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSString
-
 
-
valueOf(Object) - Static method in class org.iot.dsa.node.DSString
-
 
-
valueOf(DSElement) - Method in class org.iot.dsa.node.DSValueNode
-
 
-
valueOf(String) - Static method in enum org.iot.dsa.node.DSValueType
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum org.iot.dsa.node.event.DSInfoTopic.Event
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum org.iot.dsa.node.event.DSValueTopic.Event
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.security.DSPasswordAes
-
-
Creates a encrypted password for the given clear text.
-
-
valueOf(String) - Static method in class org.iot.dsa.security.DSPasswordAes
-
-
Creates a encrypted password for the given clear text.
-
-
valueOf(DSElement) - Method in class org.iot.dsa.security.DSPasswordSha256
-
-
Creates a digest password for the given clear text.
-
-
valueOf(String) - Static method in class org.iot.dsa.security.DSPasswordSha256
-
-
Creates a digest password for the given clear text.
-
-
valueOf(String) - Static method in enum org.iot.dsa.security.DSPermission
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(int) - Static method in enum org.iot.dsa.security.DSPermission
-
 
-
valueOf(DSElement) - Method in class org.iot.dsa.time.DSDateTime
-
 
-
valueOf(long) - Static method in class org.iot.dsa.time.DSDateTime
-
 
-
valueOf(String) - Static method in class org.iot.dsa.time.DSDateTime
-
-
Decodes an ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
-
-
valueOf(String) - Static method in enum org.iot.dsa.time.DSInterval
-
-
Returns the enum constant of this type with the specified name.
-
-
values() - Static method in enum org.iot.dsa.dslink.requester.ErrorType
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.dslink.requester.OutboundInvokeHandler.Mode
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.io.DSIReader.Token
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.node.action.ActionSpec.ResultType
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.node.DSElementType
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.node.DSValueType
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.node.event.DSInfoTopic.Event
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.node.event.DSValueTopic.Event
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.security.DSPermission
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum org.iot.dsa.time.DSInterval
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
Verifier(PublicKey) - Constructor for class org.iot.dsa.security.DSKeys.Verifier
-
 
-
verify(byte[], int, int, String) - Method in class org.iot.dsa.security.DSKeys
-
-
A convenience that creates a verifier and validates the signature for the given bytes.
-
-
- - - -

W

-
-
WARN - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
warn - Static variable in interface org.iot.dsa.logging.DSILevels
-
 
-
warn() - Method in class org.iot.dsa.logging.DSLogger
-
-
True if the level is loggable.
-
-
warn(Object) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log an unusual but not critical event.
-
-
warn(Object, Throwable) - Method in class org.iot.dsa.logging.DSLogger
-
-
Log an unusual but not critical event.
-
-
wasHelpRequested() - Method in class org.iot.dsa.dslink.DSLinkConfig
-
-
Whether or not -h or --help was provided.
-
-
write(boolean) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write the value.
-
-
write(byte[]) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write the value.
-
-
write(double) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write the value.
-
-
write(long) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write the value.
-
-
write(boolean) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
write(byte[]) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
write(double) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
write(long) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
write(LogRecord) - Method in class org.iot.dsa.logging.AsyncLogHandler
-
-
Formats and writes the logging record the underlying stream.
-
-
writeDouble(double, byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a byte array.
-
-
writeDouble(double, OutputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a stream.
-
-
writeFloat(float, byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a byte array.
-
-
writeFloat(float, OutputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a stream
-
-
writeInt(int, byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a byte array.
-
-
writeInt(int, OutputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a stream.
-
-
writeKey(CharSequence) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write string key of a map entry.
-
-
writeKey(CharSequence) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeKeyValueSeparator() - Method in class org.iot.dsa.io.AbstractWriter
-
-
Separate the key from the value in a map.
-
-
writeKeyValueSeparator() - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeListEnd() - Method in class org.iot.dsa.io.AbstractWriter
-
-
End the current list.
-
-
writeListEnd() - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeListStart(int) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Start a new list.
-
-
writeListStart(int) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeLong(long, byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a byte array.
-
-
writeLong(long, OutputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a stream.
-
-
writeMapEnd() - Method in class org.iot.dsa.io.AbstractWriter
-
-
End the current map.
-
-
writeMapEnd() - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeMapStart(int) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Start a new map.
-
-
writeMapStart(int) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeNewLineIndent() - Method in class org.iot.dsa.io.AbstractWriter
-
-
Override point for subclasses which perform use pretty printing, such as json.
-
-
writeNewLineIndent() - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
-
Two spaces per level.
-
-
writeNull() - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write a null value.
-
-
writeNull() - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeSeparator() - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write a value separator, such as the comma in json.
-
-
writeSeparator() - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
writeShort(short, byte[], int, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a byte array.
-
-
writeShort(short, OutputStream, boolean) - Static method in class org.iot.dsa.node.DSBytes
-
-
Encodes the primitive into a stream.
-
-
writeValue(CharSequence) - Method in class org.iot.dsa.io.AbstractWriter
-
-
Write the value, which will never be null.
-
-
writeValue(CharSequence) - Method in class org.iot.dsa.io.json.AbstractJsonWriter
-
 
-
-A B C D E F G H I J K L M N O P R S T U V W 
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/index.html b/docs/javadoc/index.html deleted file mode 100644 index 911329f1..00000000 --- a/docs/javadoc/index.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - -dslink-core 0.20.0 API - - - - - - - - - -<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 fe99fd9f..00000000 --- a/docs/javadoc/org/iot/dsa/DSRuntime.Timer.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - - -DSRuntime.Timer (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa
-

Class DSRuntime.Timer

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.Runnable
    -
    -
    -
    Enclosing class:
    -
    DSRuntime
    -
    -
    -
    -
    public static class DSRuntime.Timer
-extends java.lang.Object
-implements java.lang.Runnable
    -
    Can be used to inspect and cancel tasks passed to the run methods in DSRuntime.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod 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.TimersetSkipMissedIntervals(boolean skipMissed) -
      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

      - - - -
        -
      • -

        cancel

        -
        public void cancel()
        -
        Cancel execution, will not impact current running tasks and will have no effect if - already cancelled.
        -
        • -
      - - - -
        -
      • -

        getInterval

        -
        public long getInterval()
        -
        The interval between runs, zero or less for no interval.
        -
        • -
      - - - -
        -
      • -

        getRunnable

        -
        public java.lang.Runnable getRunnable()
        -
        The runnable being managed by this timer.
        -
        • -
      - - - -
        -
      • -

        isCancelled

        -
        public boolean isCancelled()
        -
        • -
      - - - -
        -
      • -

        isFinished

        -
        public boolean isFinished()
        -
        True if cancelled or was a one time execution and that has finished.
        -
        • -
      - - - -
        -
      • -

        isRunning

        -
        public boolean isRunning()
        -
        True when the runnable is being actually being executed.
        -
        • -
      - - - -
        -
      • -

        lastRun

        -
        public long lastRun()
        -
        The lastRun run or -1 if it hasn't run yet.
        -
        • -
      - - - -
        -
      • -

        nextRun

        -
        public long nextRun()
        -
        The next scheduled time to run.
        -
        -
        Returns:
        -
        0 or less when finished.
        -
        -
        • -
      - - - -
        -
      • -

        run

        -
        public void run()
        -
        Do not call.
        -
        -
        Specified by:
        -
        run in interface java.lang.Runnable
        -
        -
        • -
      - - - -
        -
      • -

        runCount

        -
        public long runCount()
        -
        The number of completed runs.
        -
        • -
      - - - -
        -
      • -

        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
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Object
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/DSRuntime.html b/docs/javadoc/org/iot/dsa/DSRuntime.html deleted file mode 100644 index ad81ca72..00000000 --- a/docs/javadoc/org/iot/dsa/DSRuntime.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - -DSRuntime (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa
-

Class DSRuntime

-
-
- -
-
    -
  • -
    -
    -
    public class DSRuntime
-extends java.lang.Object
    -
    DSA thread pool and timers.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass 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 TypeMethod and Description
      static voidrun(java.lang.Runnable arg) -
      Run as soon as possible on the application's thread pool and run only once.
      -
      static DSRuntime.Timerrun(java.lang.Runnable arg, - long start, - long interval) -
      Run periodically starting at the given time and repeat at the given millisecond interval.
      -
      static DSRuntime.TimerrunAt(java.lang.Runnable arg, - long at) -
      Run once at the given time.
      -
      static DSRuntime.TimerrunDelayed(java.lang.Runnable arg, - long delayMillis) -
      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 void run(java.lang.Runnable arg)
        -
        Run as soon as possible on the application's thread pool and run only once.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        runAt

        -
        public static DSRuntime.Timer runAt(java.lang.Runnable arg,
-                                    long at)
        -
        Run once at the given time.
        -
        -
        Parameters:
        -
        arg - What to runAt.
        -
        at - Execution time. If the time is past, it'll run right away.
        -
        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSIRequester.html b/docs/javadoc/org/iot/dsa/dslink/DSIRequester.html deleted file mode 100644 index dde7faeb..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSIRequester.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - -DSIRequester (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink
-

Interface DSIRequester

-
-
-
-
    -
  • -
    -
    -
    public interface DSIRequester
    -
    Interface for submitting outbound requests. Accessible via the connection object.
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSIResponder.html b/docs/javadoc/org/iot/dsa/dslink/DSIResponder.html deleted file mode 100644 index 5f03a410..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSIResponder.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -DSIResponder (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink
-

Interface DSIResponder

-
-
-
-
    -
  • -
    -
    -
    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:
    -
    DSInvalidPathException, -DSPermissionException, -DSRequestException
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      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.
        -
        -
        • -
      - - - -
        -
      • -

        onSet

        -
        void onSet(InboundSetRequest request)
        -
        The implementation should 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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSInternalErrorException.html b/docs/javadoc/org/iot/dsa/dslink/DSInternalErrorException.html deleted file mode 100644 index a095846a..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSInternalErrorException.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -DSInternalErrorException (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSInternalErrorException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class DSInternalErrorException
-extends java.lang.RuntimeException
    -
    Indicates an unsupported method.
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      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

      - - - -
        -
      • -

        DSInternalErrorException

        -
        public DSInternalErrorException()
        -
        • -
      - - - -
        -
      • -

        DSInternalErrorException

        -
        public DSInternalErrorException(java.lang.String message)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSInvalidPathException.html b/docs/javadoc/org/iot/dsa/dslink/DSInvalidPathException.html deleted file mode 100644 index 8797cee8..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSInvalidPathException.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -DSInvalidPathException (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSInvalidPathException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class DSInvalidPathException
-extends DSRequestException
    -
    Indicates a request path was invalid.
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSInvalidPathException(java.lang.String path) 
      -
      • -
    - -
      -
    • - - -

      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

      - - - -
        -
      • -

        DSInvalidPathException

        -
        public DSInvalidPathException(java.lang.String path)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSLink.html b/docs/javadoc/org/iot/dsa/dslink/DSLink.html deleted file mode 100644 index 3c652ca9..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSLink.html +++ /dev/null @@ -1,642 +0,0 @@ - - - - - -DSLink (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSLink

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.Iterable<DSInfo>, java.lang.Runnable, DSILevels, DSIObject
    -
    -
    -
    -
    public class DSLink
-extends DSNode
-implements java.lang.Runnable
    -
    Represents an upstream connection, a node tree, and manages the lifecycle of both. -

    -

    -

    - Links are created with DSLinkConfig object. The main method of the process is responsible for - creating the config. After instantiation, the link should call DSLink.run() -

    -

    -

    - Lifecycle: -

    - TODO

    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSLink

        -
        public DSLink()
        -
        Use the load method to create links.
        -
        -
        See Also:
        -
        load(DSLinkConfig)
        -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - - - - - - - - - - - - - -
        -
      • -

        getDsId

        -
        public java.lang.String getDsId()
        -
        Returns the unique id of the connection. This is the link name + '-' + the hash of the - public key in base64.
        -
        -
        Returns:
        -
        Never null, and url safe.
        -
        -
        • -
      - - - -
        -
      • -

        getKeys

        -
        public DSKeys getKeys()
        -
        Public / private keys of the link, used to prove identity with brokers.
        -
        • -
      - - - -
        -
      • -

        getLinkName

        -
        public java.lang.String getLinkName()
        -
        As defined in dslink.json.
        -
        • -
      - - - -
        -
      • -

        getLogName

        -
        protected java.lang.String getLogName()
        -
        Description copied from class: DSLogger
        -
        Override point, returns the simple class name by default.
        -
        -
        Overrides:
        -
        getLogName in class DSNode
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        init

        -
        protected DSLink init(DSLinkConfig config)
        -
        Configures a link instance including creating the appropriate connection.
        -
        -
        Returns:
        -
        This
        -
        -
        • -
      - - - -
        -
      • -

        load

        -
        public static DSLink load(DSLinkConfig config)
        -
        Creates a link by first testing for an existing serialized database.
        -
        -
        Parameters:
        -
        config - Configuration options
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        run

        -
        public void run()
        -
        Calls starts, waits the stableDelay, then calls stable. Does not return until this node is - stopped.
        -
        -
        Specified by:
        -
        run in interface java.lang.Runnable
        -
        -
        • -
      - - - -
        -
      • -

        onStopped

        -
        protected void onStopped()
        -
        Description copied from class: DSNode
        -
        Called once this node and its entire subtree is stopped.
        -
        -
        Overrides:
        -
        onStopped in class DSNode
        -
        -
        • -
      - - - -
        -
      • -

        save

        -
        public void save()
        -
        Serializes the configuration database.
        -
        • -
      - - - -
        -
      • -

        shutdown

        -
        public void shutdown()
        -
        Properly shuts down the link when a thread is executing the run method.
        -
        • -
      - - - - - - - -
        -
      • -

        setSaveEnabled

        -
        protected DSLink setSaveEnabled(boolean enabled)
        -
        This is a transient option intended for unit tests. True by default.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSLinkConfig.html b/docs/javadoc/org/iot/dsa/dslink/DSLinkConfig.html deleted file mode 100644 index d3c711a8..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSLinkConfig.html +++ /dev/null @@ -1,1073 +0,0 @@ - - - - - -DSLinkConfig (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink
-

Class 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.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - - - - - - - -
      Constructors 
      Constructor and Description
      DSLinkConfig() -
      This will create an empty unvalidated getConfig.
      -
      DSLinkConfig(java.io.File workingDir) -
      Can be use to change the working dir from the default process working dir.
      -
      DSLinkConfig(java.lang.String args) -
      Constructor for simulating a command line invocation, the argument will be split on the space - character.
      -
      DSLinkConfig(java.lang.String[] args) -
      Constructor for the arguments pass to a main method.
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetBrokerUri() -
      If not set, will look for the getConfig in dslink.json.
      -
      booleangetConfig(java.lang.String name, - boolean fallback) -
      Looks for the value in dslink.json and if not found, returns the fallback.
      -
      doublegetConfig(java.lang.String name, - double fallback) -
      Looks for the value in dslink.json and if not found, returns the fallback.
      -
      intgetConfig(java.lang.String name, - int fallback) -
      Looks for the value in dslink.json and if not found, returns the fallback.
      -
      longgetConfig(java.lang.String name, - long fallback) -
      Looks for the value in dslink.json and if not found, returns the fallback.
      -
      java.lang.StringgetConfig(java.lang.String name, - java.lang.String fallback) -
      Looks for the value in dslink.json and if not found, returns the fallback.
      -
      java.lang.StringgetDsaVersion() 
      DSMapgetDslinkJson() -
      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.
      -
      DSKeysgetKeys() -
      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(java.lang.String[] args) -
      Parses command line args to set the internal state of this object.
      -
      DSLinkConfigsetBrokerUri(java.lang.String arg) 
      DSLinkConfigsetConfig(java.lang.String name, - boolean value) -
      Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
      -
      DSLinkConfigsetConfig(java.lang.String name, - double value) -
      Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
      -
      DSLinkConfigsetConfig(java.lang.String name, - int value) -
      Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
      -
      DSLinkConfigsetConfig(java.lang.String name, - long value) -
      Modifies the in-memory representation of dslink.json, but it will not be saved back to disk.
      -
      DSLinkConfigsetConfig(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.
      -
      DSLinkConfigsetDslinkJson(DSMap map) -
      Directly set the map without using file io.
      -
      DSLinkConfigsetDslinkJson(java.io.File file) -
      Sets the link map by file path.
      -
      DSLinkConfigsetKeys(DSKeys keys) -
      Directly set the keys without using file io.
      -
      DSLinkConfigsetKeys(java.io.File file) -
      Sets the link keys by file path.
      -
      DSLinkConfigsetLinkName(java.lang.String arg) -
      Overrides dslink.json.
      -
      DSLinkConfigsetLogLevel(java.util.logging.Level level) -
      Overrides dslink.json.
      -
      DSLinkConfigsetLogLevel(java.lang.String level) -
      Should be one of the following (case insensitive): all, finest, finer, fine, config, info, - warning, severe, off.
      -
      DSLinkConfigsetMainType(java.lang.Class clazz) -
      The type of the root node.
      -
      DSLinkConfigsetNodesFile(java.io.File file) -
      Overrides dslink.json.
      -
      DSLinkConfigsetToken(java.lang.String arg) -
      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
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CFG_AUTH_TOKEN

        -
        public static final java.lang.String CFG_AUTH_TOKEN
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_BROKER_URL

        -
        public static final java.lang.String CFG_BROKER_URL
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_KEY_FILE

        -
        public static final java.lang.String CFG_KEY_FILE
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_LOG_LEVEL

        -
        public static final java.lang.String CFG_LOG_LEVEL
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_NODE_FILE

        -
        public static final java.lang.String CFG_NODE_FILE
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_CONNECTION_TYPE

        -
        public static final java.lang.String CFG_CONNECTION_TYPE
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_READ_TIMEOUT

        -
        public static final java.lang.String CFG_READ_TIMEOUT
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_SAVE_INTERVAL

        -
        public static final java.lang.String CFG_SAVE_INTERVAL
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_STABLE_DELAY

        -
        public static final java.lang.String CFG_STABLE_DELAY
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CFG_WS_TRANSPORT_FACTORY

        -
        public static final java.lang.String CFG_WS_TRANSPORT_FACTORY
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSLinkConfig

        -
        public DSLinkConfig()
        -
        This will create an empty unvalidated getConfig. This should not be used except for very - specific reasons such as testing.
        -
        • -
      - - - -
        -
      • -

        DSLinkConfig

        -
        public DSLinkConfig(java.io.File workingDir)
        -
        Can be use to change the working dir from the default process working dir.
        -
        -
        Parameters:
        -
        workingDir - Base directory used to resolve other files.
        -
        -
        • -
      - - - -
        -
      • -

        DSLinkConfig

        -
        public DSLinkConfig(java.lang.String args)
        -
        Constructor for simulating a command line invocation, the argument will be split on the space - character.
        -
        • -
      - - - -
        -
      • -

        DSLinkConfig

        -
        public DSLinkConfig(java.lang.String[] args)
        -
        Constructor for the arguments pass to a main method.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      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.
        -
        • -
      - - - -
        -
      • -

        getDsaVersion

        -
        public java.lang.String getDsaVersion()
        -
        • -
      - - - -
        -
      • -

        getDslinkJson

        -
        public DSMap getDslinkJson()
        -
        If not set, this will attempt to open dslink.json in the working the process directory.
        -
        • -
      - - - -
        -
      • -

        getHelpText

        -
        public static java.lang.String getHelpText()
        -
        Help text for command line options.
        -
        • -
      - - - -
        -
      • -

        getKeys

        -
        public 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. If the file does not exist, new keys will be created.
        -
        • -
      - - - -
        -
      • -

        getLinkName

        -
        public java.lang.String getLinkName()
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        getMainType

        -
        public java.lang.String getMainType()
        -
        The type of the root node.
        -
        • -
      - - - -
        -
      • -

        getToken

        -
        public java.lang.String getToken()
        -
        Authentication token for the broker, this can return null.
        -
        • -
      - - - -
        -
      • -

        parse

        -
        protected void parse(java.lang.String[] args)
        -
        Parses command line args to set the internal state of this object.
        -
        -
        Parameters:
        -
        args - The argument passed to a main method.
        -
        Throws:
        -
        java.lang.RuntimeException - if there are any problems.
        -
        -
        • -
      - - - -
        -
      • -

        setBrokerUri

        -
        public DSLinkConfig setBrokerUri(java.lang.String arg)
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        setDslinkJson

        -
        public DSLinkConfig setDslinkJson(DSMap map)
        -
        Directly set the map without using file io.
        -
        • -
      - - - -
        -
      • -

        setDslinkJson

        -
        public DSLinkConfig setDslinkJson(java.io.File file)
        -
        Sets the link map by file path. Will throw a runtime exception if there are IO problems.
        -
        • -
      - - - -
        -
      • -

        setKeys

        -
        public DSLinkConfig setKeys(DSKeys keys)
        -
        Directly set the keys without using file io.
        -
        • -
      - - - -
        -
      • -

        setKeys

        -
        public DSLinkConfig setKeys(java.io.File file)
        -
        Sets the link keys by file path. Will throw a runtime exception if there are IO problems.
        -
        • -
      - - - -
        -
      • -

        setLinkName

        -
        public DSLinkConfig setLinkName(java.lang.String arg)
        -
        Overrides dslink.json.
        -
        • -
      - - - -
        -
      • -

        setLogLevel

        -
        public DSLinkConfig setLogLevel(java.lang.String level)
        -
        Should be one of the following (case insensitive): all, finest, finer, fine, config, info, - warning, severe, off.

        Overrides dslink.json.

        -
        • -
      - - - -
        -
      • -

        setLogLevel

        -
        public DSLinkConfig setLogLevel(java.util.logging.Level level)
        -
        Overrides dslink.json.
        -
        • -
      - - - -
        -
      • -

        setNodesFile

        -
        public DSLinkConfig setNodesFile(java.io.File file)
        -
        Overrides dslink.json.
        -
        • -
      - - - -
        -
      • -

        setMainType

        -
        public DSLinkConfig setMainType(java.lang.Class clazz)
        -
        The type of the root node.
        -
        • -
      - - - -
        -
      • -

        setToken

        -
        public DSLinkConfig setToken(java.lang.String arg)
        -
        Overrides dslink.json.
        -
        • -
      - - - -
        -
      • -

        wasHelpRequested

        -
        public boolean wasHelpRequested()
        -
        Whether or not -h or --help was provided.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.Listener.html b/docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.Listener.html deleted file mode 100644 index d5cf1d00..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.Listener.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - -DSLinkConnection.Listener (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink
-

Interface DSLinkConnection.Listener

-
-
-
-
    -
  • -
    -
    Enclosing class:
    -
    DSLinkConnection
    -
    -
    -
    -
    public static interface DSLinkConnection.Listener
    -
    Intended for requester functionality so that requesters can know when to - start and stop making requests.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        onConnect

        -
        void onConnect(DSLinkConnection connection)
        -
        Called asynchronously after the connection with the endpoint is opened.
        -
        • -
      - - - -
        -
      • -

        onDisconnect

        -
        void onDisconnect(DSLinkConnection connection)
        -
        Called synchronously after the connection with the endpoint is closed.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.html b/docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.html deleted file mode 100644 index 45bdc708..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSLinkConnection.html +++ /dev/null @@ -1,599 +0,0 @@ - - - - - -DSLinkConnection (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSLinkConnection

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.Iterable<DSInfo>, DSILevels, DSIObject
    -
    -
    -
    -
    public abstract class DSLinkConnection
-extends DSNode
    -
    Represents an upstream connection with a broker. -

    - Implementations must have a no-arg public constructor. It will be dynamically added as - a child of the DSLink.

    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSLinkConnection

        -
        public DSLinkConnection()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      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.
        -
        • -
      - - - -
        -
      • -

        getConnectionId

        -
        public java.lang.String getConnectionId()
        -
        A unique descriptive tag such as a combination of the link name and the broker host.
        -
        • -
      - - - -
        -
      • -

        getLink

        -
        public DSLink getLink()
        -
        The link using this connection.
        -
        • -
      - - - -
        -
      • -

        getLogName

        -
        protected java.lang.String getLogName()
        -
        Description copied from class: DSLogger
        -
        Override point, returns the simple class name by default.
        -
        -
        Overrides:
        -
        getLogName in class DSNode
        -
        -
        • -
      - - - - - - - -
        -
      • -

        getRequester

        -
        public abstract DSIRequester getRequester()
        -
        • -
      - - - -
        -
      • -

        getSession

        -
        public abstract com.acuity.iot.dsa.dslink.protocol.DSSession getSession()
        -
        • -
      - - - -
        -
      • -

        getTransport

        -
        public abstract com.acuity.iot.dsa.dslink.transport.DSTransport getTransport()
        -
        • -
      - - - -
        -
      • -

        isConnected

        -
        public boolean isConnected()
        -
        True when a connection is established with the remote endpoint.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        onDisconnect

        -
        protected abstract void onDisconnect()
        -
        Called when this network connection has been closed. This will only be called - if the connection is has been established and onRun was called.
        -
        • -
      - - - -
        -
      • -

        onInitialize

        -
        protected abstract void onInitialize()
        -
        Always called before onConnect. If an exception is thrown onConnect and onDisconnect - will not be called.
        -
        • -
      - - - -
        -
      • -

        onRun

        -
        protected abstract void onRun()
        -
        The long term management of the connection (reading and writing). When this - returns, onDisconnect will be called.
        -
        • -
      - - - -
        -
      • -

        onStable

        -
        protected void onStable()
        -
        Starts the connection.
        -
        -
        Overrides:
        -
        onStable in class DSNode
        -
        -
        • -
      - - - -
        -
      • -

        removeListener

        -
        public void removeListener(DSLinkConnection.Listener listener)
        -
        Removes a listener for connection events.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSMainNode.html b/docs/javadoc/org/iot/dsa/dslink/DSMainNode.html deleted file mode 100644 index 052e34f1..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSMainNode.html +++ /dev/null @@ -1,404 +0,0 @@ - - - - - -DSMainNode (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSMainNode

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.Iterable<DSInfo>, DSILevels, DSIObject
    -
    -
    -
    -
    public class DSMainNode
-extends DSNode
    -
    The root DSNode that triggers a link's custom functionality . Most links will subclass this and - override declareDefaults() to bind their application logic.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSMainNode

        -
        public DSMainNode()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getLink

        -
        public DSLink getLink()
        -
        The parent link or null.
        -
        • -
      - - - -
        -
      • -

        getLogName

        -
        protected java.lang.String getLogName()
        -
        Description copied from class: DSLogger
        -
        Override point, returns the simple class name by default.
        -
        -
        Overrides:
        -
        getLogName in class DSNode
        -
        -
        • -
      - - - -
        -
      • -

        isRequester

        -
        public boolean isRequester()
        -
        Override point, returns true by default.
        -
        • -
      - - - -
        -
      • -

        isResponder

        -
        public boolean isResponder()
        -
        Override point, returns true by default.
        -
        • -
      - - - -
        -
      • -

        validateParent

        -
        public void validateParent(DSNode node)
        -
        The parent must be a DSLink instance.
        -
        -
        Overrides:
        -
        validateParent in class DSNode
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSPermissionException.html b/docs/javadoc/org/iot/dsa/dslink/DSPermissionException.html deleted file mode 100644 index e30877fb..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSPermissionException.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - -DSPermissionException (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSPermissionException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class DSPermissionException
-extends DSRequestException
    -
    Indicates a request has insufficient permissions.
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      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

      - - - -
        -
      • -

        DSPermissionException

        -
        public DSPermissionException()
        -
        • -
      - - - -
        -
      • -

        DSPermissionException

        -
        public DSPermissionException(java.lang.String message)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSRequestException.html b/docs/javadoc/org/iot/dsa/dslink/DSRequestException.html deleted file mode 100644 index 00001cea..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSRequestException.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - -DSRequestException (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSRequestException

-
-
- -
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDetail() -
      Additional information to supply to the remote endpoint.
      -
      voidsetDetail(java.lang.String detail) -
      Overrides the default detail which is the stack trace of this exception.
      -
      voidsetDetail(java.lang.Throwable arg) -
      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

      - - - -
        -
      • -

        DSRequestException

        -
        public DSRequestException()
        -
        • -
      - - - -
        -
      • -

        DSRequestException

        -
        public DSRequestException(java.lang.String message)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getDetail

        -
        public java.lang.String getDetail()
        -
        Additional information to supply to the remote endpoint.
        -
        • -
      - - - -
        -
      • -

        setDetail

        -
        public void setDetail(java.lang.String detail)
        -
        Overrides the default detail which is the stack trace of this exception.
        -
        • -
      - - - -
        -
      • -

        setDetail

        -
        public void setDetail(java.lang.Throwable arg)
        -
        Overrides the default detail which is the stack trace of this exception.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSSysNode.html b/docs/javadoc/org/iot/dsa/dslink/DSSysNode.html deleted file mode 100644 index ec8eb377..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSSysNode.html +++ /dev/null @@ -1,441 +0,0 @@ - - - - - -DSSysNode (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSSysNode

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.Iterable<DSInfo>, DSILevels, DSIObject
    -
    -
    -
    -
    public class DSSysNode
-extends DSNode
    -
    The root of the system nodes.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      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 in class DSNode
        -
        See Also:
        -
        To create non-removable children.
        -
        -
        • -
      - - - - - - - -
        -
      • -

        getLink

        -
        public DSLink getLink()
        -
        • -
      - - - -
        -
      • -

        getLogName

        -
        protected java.lang.String getLogName()
        -
        Description copied from class: DSLogger
        -
        Override point, returns the simple class name by default.
        -
        -
        Overrides:
        -
        getLogName in class DSNode
        -
        -
        • -
      - - - -
        -
      • -

        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 in class 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 in class DSNode
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/DSUnsupportedException.html b/docs/javadoc/org/iot/dsa/dslink/DSUnsupportedException.html deleted file mode 100644 index 9508f149..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/DSUnsupportedException.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - -DSUnsupportedException (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink
-

Class DSUnsupportedException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class DSUnsupportedException
-extends DSRequestException
    -
    Indicates an unsupported method.
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      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

      - - - -
        -
      • -

        DSUnsupportedException

        -
        public DSUnsupportedException()
        -
        • -
      - - - -
        -
      • -

        DSUnsupportedException

        -
        public DSUnsupportedException(java.lang.String message)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/package-frame.html b/docs/javadoc/org/iot/dsa/dslink/package-frame.html deleted file mode 100644 index 22ea58de..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/package-frame.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - - -org.iot.dsa.dslink (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.dslink

-
-

Interfaces

- -

Classes

- -

Exceptions

- -
- - diff --git a/docs/javadoc/org/iot/dsa/dslink/package-summary.html b/docs/javadoc/org/iot/dsa/dslink/package-summary.html deleted file mode 100644 index d88b9bb3..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/package-summary.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - -org.iot.dsa.dslink (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.dslink

-
-
DSLink is the main entry point for an application.
-
-

See: Description

-
-
- - - - -

Package org.iot.dsa.dslink Description

-
DSLink is the main entry point for an application.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/package-tree.html b/docs/javadoc/org/iot/dsa/dslink/package-tree.html deleted file mode 100644 index fc4d14e5..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/package-tree.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - -org.iot.dsa.dslink Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.dslink

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/AbstractInvokeHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/AbstractInvokeHandler.html deleted file mode 100644 index 8aa15916..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/AbstractInvokeHandler.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - -AbstractInvokeHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Class AbstractInvokeHandler

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AbstractInvokeHandler

        -
        public AbstractInvokeHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getParams

        -
        public DSMap getParams()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        getPath

        -
        public java.lang.String getPath()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        getStream

        -
        public OutboundStream getStream()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        onInit

        -
        public void onInit(java.lang.String path,
-                   DSMap params,
-                   OutboundStream stream)
        -
        Sets the fields so they can be access via the corresponding getters. - -

        - - Called by the requester before returning from the invoke method.

        -
        -
        Specified by:
        -
        onInit in interface OutboundInvokeHandler
        -
        Parameters:
        -
        path - Path being listed.
        -
        params - Parameter to the invoke method.
        -
        stream - Mechanism to close the request stream.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/AbstractListHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/AbstractListHandler.html deleted file mode 100644 index a4b434aa..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/AbstractListHandler.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - -AbstractListHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Class AbstractListHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    OutboundListHandler, OutboundRequestHandler
    -
    -
    -
    -
    public abstract class AbstractListHandler
-extends java.lang.Object
-implements OutboundListHandler
    -
    Convenience implementation of the handler passed to the invoke method in the requester. - -

    - - onUpdate will be called until the initial state is fully loaded. After which onInitialized will - be called. After that, onUpdate and onRemove will be called for state changes. - -

    - - Configs, or node metadata names start with $. Attributes start with @. Anything else represents - a child. Child maps will only contain configs/node metadata.

    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AbstractListHandler

        -
        public AbstractListHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getPath

        -
        public java.lang.String getPath()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        getStream

        -
        public OutboundStream getStream()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        onInit

        -
        public void onInit(java.lang.String path,
-                   OutboundStream stream)
        -
        Sets the fields so they can be accessed with the corresponding getters. - -

        - - Called by the requester before returning from the list method.

        -
        -
        Specified by:
        -
        onInit in interface OutboundListHandler
        -
        Parameters:
        -
        path - Parameter to the list method.
        -
        stream - Mechanism to close the request stream.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/AbstractSubscribeHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/AbstractSubscribeHandler.html deleted file mode 100644 index 1a2a07d8..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/AbstractSubscribeHandler.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - -AbstractSubscribeHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Class AbstractSubscribeHandler

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AbstractSubscribeHandler

        -
        public AbstractSubscribeHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getPath

        -
        public java.lang.String getPath()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        getQos

        -
        public int getQos()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        getStream

        -
        public OutboundStream getStream()
        -
        Returns the value passed to onInit.
        -
        • -
      - - - -
        -
      • -

        onInit

        -
        public void onInit(java.lang.String path,
-                   int qos,
-                   OutboundStream stream)
        -
        Sets the fields so they can be accessed via the corresponding getters. - -

        - - Called by the requester before returning from the subscribe method.

        -
        -
        Specified by:
        -
        onInit in interface OutboundSubscribeHandler
        -
        Parameters:
        -
        path - Who is being subscribed.
        -
        qos - Quality of service, 0-3.
        -
        stream - Mechanism to close the request stream.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/ErrorType.html b/docs/javadoc/org/iot/dsa/dslink/requester/ErrorType.html deleted file mode 100644 index 8768f1c3..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/ErrorType.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - -ErrorType (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Enum ErrorType

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<ErrorType>
    -
    -
    -
    -
    public enum ErrorType
-extends java.lang.Enum<ErrorType>
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.lang.RuntimeExceptionmakeException(ErrorType type, - java.lang.String message) 
      static ErrorTypevalueOf(java.lang.String name) -
      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
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        badRequest

        -
        public static final ErrorType badRequest
        -
        • -
      - - - -
        -
      • -

        internalError

        -
        public static final ErrorType internalError
        -
        • -
      - - - -
        -
      • -

        notSupported

        -
        public static final ErrorType notSupported
        -
        • -
      - - - -
        -
      • -

        permissionDenied

        -
        public static final ErrorType permissionDenied
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static ErrorType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (ErrorType c : ErrorType.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      - - - -
        -
      • -

        makeException

        -
        public static java.lang.RuntimeException makeException(ErrorType type,
-                                                       java.lang.String message)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.Mode.html b/docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.Mode.html deleted file mode 100644 index e31d1d8b..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.Mode.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - -OutboundInvokeHandler.Mode (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Enum OutboundInvokeHandler.Mode

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - -
      Enum Constants 
      Enum Constant and Description
      APPEND 
      REFRESH 
      STREAM 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static OutboundInvokeHandler.ModevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static OutboundInvokeHandler.Mode[]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

      - - - -
        -
      • -

        values

        -
        public static OutboundInvokeHandler.Mode[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (OutboundInvokeHandler.Mode c : OutboundInvokeHandler.Mode.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.html deleted file mode 100644 index c9e83f7f..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundInvokeHandler.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - -OutboundInvokeHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Interface OutboundInvokeHandler

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeInterface and Description
      static class OutboundInvokeHandler.Mode 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      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.
        -
        -
        • -
      - - - -
        -
      • -

        onTableMeta

        -
        void onTableMeta(DSMap map)
        -
        Called whenever metadata for the entire table is received.
        -
        • -
      - - - -
        -
      • -

        onUpdate

        -
        void onUpdate(DSList row)
        -
        Called for every row.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundListHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/OutboundListHandler.html deleted file mode 100644 index a308d605..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundListHandler.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - -OutboundListHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Interface OutboundListHandler

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    OutboundRequestHandler
    -
    -
    -
    All Known Implementing Classes:
    -
    AbstractListHandler
    -
    -
    -
    -
    public interface OutboundListHandler
-extends OutboundRequestHandler
    -
    Callback mechanism passed to the list method on DSIRequester. - -
      - -
    • onInit will be called first, before the list method returns. - -
    • onUpdate will be called until the initial state is fully loaded. - -
    • onInitialized when the initial state of the target has been fully loaded. - -
    • onRemove and onUpdate will be called for subsequent changed to the target. - -
    - - Configs, or node metadata names, start with $. Attributes start with @. Anything else - represents a child. Child maps will only contain configs/node metadata.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidonInit(java.lang.String path, - 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(java.lang.String name) -
      Only called after onOpen(), indicates something about the target of the request has been - removed.
      -
      voidonUpdate(java.lang.String name, - 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.
        -
        -
        • -
      - - - -
        -
      • -

        onInitialized

        -
        void onInitialized()
        -
        Called once the initial state of the target has been transmitted. This is a good place to - call close if not interested in future updates.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundRequestHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/OutboundRequestHandler.html deleted file mode 100644 index d3bd54aa..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundRequestHandler.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - -OutboundRequestHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Interface OutboundRequestHandler

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod 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

      - - - -
        -
      • -

        onClose

        -
        void onClose()
        -
        Callback for when the request stream is closed, no matter how or by who. Will be called if - there is an error as well.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundStream.html b/docs/javadoc/org/iot/dsa/dslink/requester/OutboundStream.html deleted file mode 100644 index a461ca9f..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundStream.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - -OutboundStream (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Interface OutboundStream

-
-
-
-
    -
  • -
    -
    -
    public interface OutboundStream
    -
    Mechanism for the requester to close outbound requests.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        closeStream

        -
        void closeStream()
        -
        Allows the requester to close the stream.
        -
        • -
      - - - -
        -
      • -

        isStreamOpen

        -
        boolean isStreamOpen()
        -
        Whether or not the request is open.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundSubscribeHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/OutboundSubscribeHandler.html deleted file mode 100644 index a902b78f..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/OutboundSubscribeHandler.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - -OutboundSubscribeHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Interface OutboundSubscribeHandler

-
-
-
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/SimpleInvokeHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/SimpleInvokeHandler.html deleted file mode 100644 index 36900b4e..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/SimpleInvokeHandler.html +++ /dev/null @@ -1,500 +0,0 @@ - - - - - -SimpleInvokeHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Class SimpleInvokeHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    OutboundInvokeHandler, OutboundRequestHandler
    -
    -
    -
    -
    public class SimpleInvokeHandler
-extends AbstractInvokeHandler
    -
    Action handler for non-tables/streams. -

    - Call getResult(long timeout) to block until the invocation is complete. It will either return - the result (possibly null), or throw an exception.

    -
    • -
-
-
-
    -
  • - - - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DSListgetResult(long timeout) -
      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(int index, - DSList rows) -
      Will result in an error since tables and streams are not supported.
      -
      voidonMode(OutboundInvokeHandler.Mode mode) -
      Does nothing.
      -
      voidonReplace(int start, - int end, - 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.
      -
      SimpleInvokeHandlersetAutoClose(boolean arg) -
      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

      - - - -
        -
      • -

        SimpleInvokeHandler

        -
        public SimpleInvokeHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      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.wait
        -
        Returns:
        -
        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.
        -
        • -
      - - - -
        -
      • -

        onClose

        -
        public void onClose()
        -
        Causes getResult to return.
        -
        • -
      - - - -
        -
      • -

        onError

        -
        public void onError(ErrorType type,
-                    java.lang.String msg)
        -
        Will create an exception to be thrown by getResult.
        -
        • -
      - - - -
        -
      • -

        onColumns

        -
        public void onColumns(DSList list)
        -
        Does nothing.
        -
        -
        Parameters:
        -
        list - A list of maps.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        onTableMeta

        -
        public void onTableMeta(DSMap map)
        -
        Description copied from interface: OutboundInvokeHandler
        -
        Called whenever metadata for the entire table is received.
        -
        • -
      - - - -
        -
      • -

        onUpdate

        -
        public void onUpdate(DSList row)
        -
        Captures the result and if auto-close is true, closes the stream.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/SimpleRequestHandler.html b/docs/javadoc/org/iot/dsa/dslink/requester/SimpleRequestHandler.html deleted file mode 100644 index 8726458a..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/SimpleRequestHandler.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - -SimpleRequestHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.dslink.requester
-

Class SimpleRequestHandler

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static SimpleRequestHandlerDEFAULT -
      An instance that can be used for those requests where the callbacks don't really matter.
      -
      -
      • -
    - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidonClose() -
      Does nothing by default.
      -
      voidonError(ErrorType type, - java.lang.String msg) -
      Does nothing by default.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        DEFAULT

        -
        public static final SimpleRequestHandler DEFAULT
        -
        An instance that can be used for those requests where the callbacks don't really matter.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SimpleRequestHandler

        -
        public SimpleRequestHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      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 in interface OutboundRequestHandler
        -
        -
        • -
      - - - -
        -
      • -

        onError

        -
        public void onError(ErrorType type,
-                    java.lang.String msg)
        -
        Does nothing by default. - -

        - - Callback for when an error is received. onClose will also be called after this. - Does nothing by default.

        -
        -
        Specified by:
        -
        onError in interface OutboundRequestHandler
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/package-frame.html b/docs/javadoc/org/iot/dsa/dslink/requester/package-frame.html deleted file mode 100644 index 1f393c03..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/package-frame.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -org.iot.dsa.dslink.requester (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.dslink.requester

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/package-summary.html b/docs/javadoc/org/iot/dsa/dslink/requester/package-summary.html deleted file mode 100644 index 31fa9d04..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/package-summary.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - -org.iot.dsa.dslink.requester (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.dslink.requester

-
-
API for implementing requesters without having to modeling everything in the node tree.
-
-

See: Description

-
-
- - - - -

Package org.iot.dsa.dslink.requester Description

-
API for implementing requesters without having to modeling everything in the node tree.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/requester/package-tree.html b/docs/javadoc/org/iot/dsa/dslink/requester/package-tree.html deleted file mode 100644 index 91340aa3..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/requester/package-tree.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - -org.iot.dsa.dslink.requester Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.dslink.requester

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/ApiObject.html b/docs/javadoc/org/iot/dsa/dslink/responder/ApiObject.html deleted file mode 100644 index ee5f69b4..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/ApiObject.html +++ /dev/null @@ -1,384 +0,0 @@ - - - - - -ApiObject (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface ApiObject

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    DSInfo
    -
    -
    -
    -
    public interface ApiObject
    -
    Can be a node, value or an action.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      ActionSpecgetAction() -
      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.
      -
      DSIValuegetValue() -
      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

      - - - -
        -
      • -

        getAction

        -
        ActionSpec getAction()
        -
        The action, should only be called if isAction() returns true.
        -
        • -
      - - - -
        -
      • -

        getChildren

        -
        java.util.Iterator<ApiObject> getChildren()
        -
        Iterator of child objects, should only be called if hasChildren() returns true.
        -
        • -
      - - - -
        -
      • -

        getMetadata

        -
        void getMetadata(DSMap bucket)
        -
        • -
      - - - -
        -
      • -

        getName

        -
        java.lang.String getName()
        -
        The display name.
        -
        • -
      - - - -
        -
      • -

        getValue

        -
        DSIValue getValue()
        -
        Value of the object, should only be called if isValue() returns true.
        -
        • -
      - - - -
        -
      • -

        hasChildren

        -
        boolean hasChildren()
        -
        True if getChildren() can be called.
        -
        • -
      - - - -
        -
      • -

        isAction

        -
        boolean isAction()
        -
        True if the object is an action.
        -
        • -
      - - - -
        -
      • -

        isAdmin

        -
        boolean isAdmin()
        -
        Whether or not this object requires configuration permission to read/write.
        -
        • -
      - - - -
        -
      • -

        isHidden

        -
        boolean isHidden()
        -
        True if the object should ignored (not be exposed through the api).
        -
        • -
      - - - -
        -
      • -

        isReadOnly

        -
        boolean isReadOnly()
        -
        True if the object is a value and cannot be written.
        -
        • -
      - - - -
        -
      • -

        isValue

        -
        boolean isValue()
        -
        True if getValue() can be called.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/InboundInvokeRequest.html b/docs/javadoc/org/iot/dsa/dslink/responder/InboundInvokeRequest.html deleted file mode 100644 index dfe229d9..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/InboundInvokeRequest.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - -InboundInvokeRequest (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface InboundInvokeRequest

-
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/InboundListRequest.html b/docs/javadoc/org/iot/dsa/dslink/responder/InboundListRequest.html deleted file mode 100644 index 1b953304..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/InboundListRequest.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - -InboundListRequest (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface InboundListRequest

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod 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(java.lang.Exception reason) -
      Allows the responder to forcefully close the list stream.
      -
      booleanisOpen() -
      Whether or not the list stream is still open.
      -
      - -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        childAdded

        -
        void childAdded(ApiObject child)
        -
        The responder should call this whenever a child is added.
        -
        • -
      - - - -
        -
      • -

        childRemoved

        -
        void childRemoved(ApiObject child)
        -
        The responder should call this whenever a child is removed.
        -
        • -
      - - - -
        -
      • -

        close

        -
        void close()
        -
        Allows the responder to forcefully close the list stream.
        -
        • -
      - - - -
        -
      • -

        close

        -
        void close(java.lang.Exception reason)
        -
        Allows the responder to forcefully close the list stream.
        -
        • -
      - - - -
        -
      • -

        isOpen

        -
        boolean isOpen()
        -
        Whether or not the list stream is still open.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/InboundRequest.html b/docs/javadoc/org/iot/dsa/dslink/responder/InboundRequest.html deleted file mode 100644 index 4a4ac307..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/InboundRequest.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - -InboundRequest (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface InboundRequest

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetPath() -
      The target of the request.
      -
      java.lang.IntegergetRequestId() -
      Unique ID of the request, or 0 for subscriptions.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getPath

        -
        java.lang.String getPath()
        -
        The target of the request.
        -
        • -
      - - - -
        -
      • -

        getRequestId

        -
        java.lang.Integer getRequestId()
        -
        Unique ID of the request, or 0 for subscriptions.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/InboundSetRequest.html b/docs/javadoc/org/iot/dsa/dslink/responder/InboundSetRequest.html deleted file mode 100644 index 8131c075..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/InboundSetRequest.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - -InboundSetRequest (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface InboundSetRequest

-
-
-
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getValue

        -
        DSElement getValue()
        -
        The value to set.
        -
        • -
      - - - -
        -
      • -

        getPermission

        -
        DSPermission getPermission()
        -
        The permission to set with.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/InboundSubscribeRequest.html b/docs/javadoc/org/iot/dsa/dslink/responder/InboundSubscribeRequest.html deleted file mode 100644 index c8700aa7..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/InboundSubscribeRequest.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - -InboundSubscribeRequest (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface InboundSubscribeRequest

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidclose() -
      Allows the responder to forcefully terminate the subscription.
      -
      java.lang.IntegergetSubscriptionId() -
      Unique subscription id for this path.
      -
      voidupdate(long timestamp, - DSIValue value, - DSStatus quality) -
      The responder should call this when first received and then whenever the value or status - changes.
      -
      - -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        close

        -
        void close()
        -
        Allows the responder to forcefully terminate the subscription.
        -
        • -
      - - - -
        -
      • -

        getSubscriptionId

        -
        java.lang.Integer getSubscriptionId()
        -
        Unique subscription id for this path.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/OutboundListResponse.html b/docs/javadoc/org/iot/dsa/dslink/responder/OutboundListResponse.html deleted file mode 100644 index d2c85cc4..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/OutboundListResponse.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - -OutboundListResponse (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface OutboundListResponse

-
-
-
-
    -
  • -
    -
    -
    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 Detail

      - - - -
        -
      • -

        getTarget

        -
        ApiObject getTarget()
        -
        The object that represents the path of the request.
        -
        • -
      - - - -
        -
      • -

        onClose

        -
        void onClose()
        -
        Will be called no matter how the stream is closed.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/SubscriptionCloseHandler.html b/docs/javadoc/org/iot/dsa/dslink/responder/SubscriptionCloseHandler.html deleted file mode 100644 index ef23c9e0..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/SubscriptionCloseHandler.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - -SubscriptionCloseHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.dslink.responder
-

Interface SubscriptionCloseHandler

-
-
-
-
    -
  • -
    -
    -
    public interface SubscriptionCloseHandler
    -
    The responder returns this from the subscription request notification method so the link can - notify the responder whenever a subscription is terminated.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidonClose(java.lang.Integer subscriptionId) -
      Will be called no matter how the subscription is terminated.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        onClose

        -
        void onClose(java.lang.Integer subscriptionId)
        -
        Will be called no matter how the subscription is terminated.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/package-frame.html b/docs/javadoc/org/iot/dsa/dslink/responder/package-frame.html deleted file mode 100644 index e12e4531..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/package-frame.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - -org.iot.dsa.dslink.responder (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.dslink.responder

-
-

Interfaces

- -
- - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/package-summary.html b/docs/javadoc/org/iot/dsa/dslink/responder/package-summary.html deleted file mode 100644 index 1f65ee31..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/package-summary.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - -org.iot.dsa.dslink.responder (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.dslink.responder

-
-
API for implementing responders without having modeling everything in the node tree.
-
-

See: Description

-
-
- - - - -

Package org.iot.dsa.dslink.responder Description

-
API for implementing responders without having modeling everything in the node tree.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/dslink/responder/package-tree.html b/docs/javadoc/org/iot/dsa/dslink/responder/package-tree.html deleted file mode 100644 index 9c67fb07..00000000 --- a/docs/javadoc/org/iot/dsa/dslink/responder/package-tree.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - -org.iot.dsa.dslink.responder Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.dslink.responder

-Package Hierarchies: - -
-
-

Interface Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - 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 4188a4d9..00000000 --- a/docs/javadoc/org/iot/dsa/io/AbstractReader.html +++ /dev/null @@ -1,764 +0,0 @@ - - - - - -AbstractReader (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.io
-

Class AbstractReader

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Closeable, java.lang.AutoCloseable, DSIReader
    -
    -
    -
    Direct Known Subclasses:
    -
    JsonReader
    -
    -
    -
    -
    public abstract class AbstractReader
-extends java.lang.Object
-implements DSIReader
    -
    Basic implementation of DSReader. Subclasses must implement the next() method.
    -
    -
    See Also:
    -
    next(), -DSIReader
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        valBoolean

        -
        protected boolean valBoolean
        -
        • -
      - - - -
        -
      • -

        valBytes

        -
        protected byte[] valBytes
        -
        • -
      - - - -
        -
      • -

        valReal

        -
        protected double valReal
        -
        • -
      - - - -
        -
      • -

        valLong

        -
        protected long valLong
        -
        • -
      - - - -
        -
      • -

        valString

        -
        protected java.lang.String valString
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AbstractReader

        -
        public AbstractReader()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getBoolean

        -
        public boolean getBoolean()
        -
        Description copied from interface: DSIReader
        -
        Returns the value when last() == BOOLEAN.
        -
        -
        Specified by:
        -
        getBoolean in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        getBytes

        -
        public byte[] getBytes()
        -
        Description copied from interface: DSIReader
        -
        Returns the value when last() == BYTES.
        -
        -
        Specified by:
        -
        getBytes in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        getDouble

        -
        public double getDouble()
        -
        Description copied from interface: DSIReader
        -
        Returns the value when last() == DOUBLE.
        -
        -
        Specified by:
        -
        getDouble in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        getElement

        -
        public DSElement getElement()
        -
        Description copied from interface: DSIReader
        -
        Returns the DSElement when last() == raw type or ROOT.
        -
        -
        Specified by:
        -
        getElement in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        getList

        -
        public DSList getList()
        -
        Description copied from interface: DSIReader
        -
        This should only be called when last() == BEGIN_LIST and it will decodeKeys the entire - list. Call next rather than this method to get the list in pieces.
        -
        -
        Specified by:
        -
        getList in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        getLong

        -
        public long getLong()
        -
        Description copied from interface: DSIReader
        -
        Returns the value when last() == LONG.
        -
        -
        Specified by:
        -
        getLong in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        getMap

        -
        public DSMap getMap()
        -
        Description copied from interface: DSIReader
        -
        This should only be called when last() == BEGIN_MAP and it will decodeKeys the entire map. - Call next rather than this method get the map in pieces.
        -
        -
        Specified by:
        -
        getMap in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString()
        -
        Description copied from interface: DSIReader
        -
        Returns the value when last() == STRING.
        -
        -
        Specified by:
        -
        getString in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        last

        -
        public DSIReader.Token last()
        -
        Description copied from interface: DSIReader
        -
        The last value returned from next(). At the beginning of a document, before next has been - called, this will return ROOT.
        -
        -
        Specified by:
        -
        last in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        next

        -
        public abstract DSIReader.Token next()
        -
        Subclasses must override this, read the next item from the stream, then call one of the - setXxx methods. - -

        - - Advances the reader to the next item and returns the token representing it's current state.

        -
        -
        Specified by:
        -
        next in interface DSIReader
        -
        -
        • -
      - - - - - - - - - - - - - - - - - - - - - - - -
        -
      • -

        setNextValue

        -
        protected DSIReader.Token setNextValue(boolean arg)
        -
        • -
      - - - -
        -
      • -

        setNextValue

        -
        protected DSIReader.Token setNextValue(byte[] arg)
        -
        • -
      - - - -
        -
      • -

        setNextValue

        -
        protected DSIReader.Token setNextValue(double arg)
        -
        • -
      - - - - - - - -
        -
      • -

        setNextValue

        -
        protected DSIReader.Token setNextValue(java.lang.String arg)
        -
        • -
      - - - - - - - - -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/AbstractWriter.html b/docs/javadoc/org/iot/dsa/io/AbstractWriter.html deleted file mode 100644 index 401a434d..00000000 --- a/docs/javadoc/org/iot/dsa/io/AbstractWriter.html +++ /dev/null @@ -1,977 +0,0 @@ - - - - - -AbstractWriter (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.io
-

Class 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 TypeField and Description
      protected booleanprettyPrint -
      Subclasses can use this if applicable.
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      AbstractWriter() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      AbstractWriterbeginList() -
      Start a new list and return this.
      -
      AbstractWriterbeginList(int size) -
      Start a new list of the given size and return this.
      -
      AbstractWriterbeginMap() -
      Start a new map and return this.
      -
      AbstractWriterbeginMap(int size) -
      Start a new map of the given size and return this.
      -
      AbstractWriterendList() -
      End the current list.
      -
      AbstractWriterendMap() -
      End the current map.
      -
      protected intgetDepth() -
      Current depth in the tree, will be needed by writeNewLineIndent.
      -
      AbstractWriterkey(java.lang.CharSequence arg) -
      Write a key in the current map.
      -
      intlength() -
      Returns 0 by default.
      -
      AbstractWriterreset() -
      Clears the state of the writer.
      -
      AbstractWritervalue(boolean arg) -
      Write a value to the map or list.
      -
      AbstractWritervalue(byte[] arg) -
      Write a value to the map or list.
      -
      AbstractWritervalue(double arg) -
      Write a value to the map or list.
      -
      AbstractWritervalue(DSElement arg) -
      Write a value to the map or list.
      -
      AbstractWritervalue(int arg) -
      Write a value to the map or list.
      -
      AbstractWritervalue(long arg) -
      Write a value to the map or list.
      -
      AbstractWritervalue(java.lang.String arg) -
      Write a value to the map or list.
      -
      protected abstract voidwrite(boolean arg) -
      Write the value.
      -
      protected abstract voidwrite(byte[] arg) -
      Write the value.
      -
      protected abstract voidwrite(double arg) -
      Write the value.
      -
      protected abstract voidwrite(long arg) -
      Write the value.
      -
      protected abstract voidwriteKey(java.lang.CharSequence arg) -
      Write string key of a map entry.
      -
      protected abstract voidwriteKeyValueSeparator() -
      Separate the key from the value in a map.
      -
      protected abstract voidwriteListEnd() -
      End the current list.
      -
      protected abstract voidwriteListStart(int size) -
      Start a new list.
      -
      protected abstract voidwriteMapEnd() -
      End the current map.
      -
      protected abstract voidwriteMapStart(int size) -
      Start a new map.
      -
      protected voidwriteNewLineIndent() -
      Override point for subclasses which perform use pretty printing, such as json.
      -
      protected abstract voidwriteNull() -
      Write a null value.
      -
      protected abstract voidwriteSeparator() -
      Write a value separator, such as the comma in json.
      -
      protected abstract voidwriteValue(java.lang.CharSequence arg) -
      Write the value, which will never be null.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      - -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        prettyPrint

        -
        protected boolean prettyPrint
        -
        Subclasses can use this if applicable.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AbstractWriter

        -
        public AbstractWriter()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        beginList

        -
        public AbstractWriter beginList(int size)
        -
        Description copied from interface: DSIWriter
        -
        Start a new list of the given size and return this.
        -
        -
        Specified by:
        -
        beginList in interface DSIWriter
        -
        Parameters:
        -
        size - Less than zero means the size is unknown.
        -
        -
        • -
      - - - - - - - -
        -
      • -

        beginMap

        -
        public AbstractWriter beginMap(int size)
        -
        Description copied from interface: DSIWriter
        -
        Start a new map of the given size and return this.
        -
        -
        Specified by:
        -
        beginMap in interface DSIWriter
        -
        Parameters:
        -
        size - Less than zero means the size is unknown.
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        getDepth

        -
        protected int getDepth()
        -
        Current depth in the tree, will be needed by writeNewLineIndent.
        -
        • -
      - - - -
        -
      • -

        key

        -
        public AbstractWriter key(java.lang.CharSequence arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        length

        -
        public int length()
        -
        Returns 0 by default.
        -
        -
        Specified by:
        -
        length in interface DSIWriter
        -
        -
        • -
      - - - - - - - -
        -
      • -

        value

        -
        public AbstractWriter value(DSElement arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        value

        -
        public AbstractWriter value(boolean arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        value

        -
        public AbstractWriter value(byte[] arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        value

        -
        public AbstractWriter value(double arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        value

        -
        public AbstractWriter value(int arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        value

        -
        public AbstractWriter value(long arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        value

        -
        public AbstractWriter value(java.lang.String arg)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected abstract void write(boolean arg)
-                       throws java.io.IOException
        -
        Write the value.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected abstract void write(byte[] arg)
-                       throws java.io.IOException
        -
        Write the value.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected abstract void write(double arg)
-                       throws java.io.IOException
        -
        Write the value.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected abstract void write(long arg)
-                       throws java.io.IOException
        -
        Write the value.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeKey

        -
        protected abstract void writeKey(java.lang.CharSequence arg)
-                          throws java.io.IOException
        -
        Write string key of a map entry.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeKeyValueSeparator

        -
        protected abstract void writeKeyValueSeparator()
-                                        throws java.io.IOException
        -
        Separate the key from the value in a map.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeListEnd

        -
        protected abstract void writeListEnd()
-                              throws java.io.IOException
        -
        End the current list.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeListStart

        -
        protected abstract void writeListStart(int size)
-                                throws java.io.IOException
        -
        Start a new list.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeMapEnd

        -
        protected abstract void writeMapEnd()
-                             throws java.io.IOException
        -
        End the current map.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeMapStart

        -
        protected abstract void writeMapStart(int size)
-                               throws java.io.IOException
        -
        Start a new map.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        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.IOException
        -
        See Also:
        -
        getDepth()
        -
        -
        • -
      - - - -
        -
      • -

        writeNull

        -
        protected abstract void writeNull()
-                           throws java.io.IOException
        -
        Write a null value.
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        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
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/DSBase64.html b/docs/javadoc/org/iot/dsa/io/DSBase64.html deleted file mode 100644 index b05d64be..00000000 --- a/docs/javadoc/org/iot/dsa/io/DSBase64.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - -DSBase64 (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.io
-

Class DSBase64

-
-
- -
-
    -
  • -
    -
    -
    public class DSBase64
-extends java.lang.Object
    -
    Thread-safe Base64 encoder and decoder. This only exists because we need to be compatible with - Java 6.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSBase64() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static byte[]decode(java.lang.String str) -
      Decodes a base 64 encoded string.
      -
      static java.lang.Stringencode(byte[] buf) -
      Encodes the bytes into a single line string with no padding.
      -
      static java.lang.Stringencode(byte[] buf, - int linelen) -
      Encodes the buffer into a String with the given line length.
      -
      static java.lang.StringencodeUrl(byte[] bytes) -
      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

      - - - -
        -
      • -

        decode

        -
        public static byte[] decode(java.lang.String str)
        -
        Decodes a base 64 encoded string. Will decodeKeys both url safe and unsafe.
        -
        -
        Parameters:
        -
        str - Most not be null.
        -
        Returns:
        -
        Never null.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If anything is wrong with the parameter.
        -
        -
        • -
      - - - -
        -
      • -

        encode

        -
        public static java.lang.String encode(byte[] buf)
        -
        Encodes the bytes into a single line string with no padding.
        -
        -
        Parameters:
        -
        buf - The bytes to encode.
        -
        Returns:
        -
        The encoding.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        encodeUrl

        -
        public static java.lang.String encodeUrl(byte[] bytes)
        -
        Encodes to a URL safe base64 string. Replaces / with _ and + with -.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/DSIReader.Token.html b/docs/javadoc/org/iot/dsa/io/DSIReader.Token.html deleted file mode 100644 index 36ce3c18..00000000 --- a/docs/javadoc/org/iot/dsa/io/DSIReader.Token.html +++ /dev/null @@ -1,464 +0,0 @@ - - - - - -DSIReader.Token (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.io
-

Enum DSIReader.Token

-
-
- -
-
    -
  • -
    -
    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.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSIReader.TokenvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static DSIReader.Token[]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

      - - - -
        -
      • -

        values

        -
        public static DSIReader.Token[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DSIReader.Token c : DSIReader.Token.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/DSIReader.html b/docs/javadoc/org/iot/dsa/io/DSIReader.html deleted file mode 100644 index 3a0619d0..00000000 --- a/docs/javadoc/org/iot/dsa/io/DSIReader.html +++ /dev/null @@ -1,471 +0,0 @@ - - - - - -DSIReader (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.io
-

Interface DSIReader

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    java.lang.AutoCloseable, java.io.Closeable
    -
    -
    -
    All Known Implementing Classes:
    -
    AbstractReader, JsonReader
    -
    -
    -
    -
    public interface DSIReader
-extends java.io.Closeable
    -
    A decoder that can be used to get an entire graph in pieces, or one large group, or somewhere in - between. To get an entire graph, call getElement(), getMap() or getList(). Otherwise, use the - next() method to iterate the elements of the input. - -

    - - When next() returns: - -

      - -
    • ROOT - The initial state, not in a list or map, call next() or getElement(). - -
    • BEGIN_LIST - Call getList() to decodeKeys the entire list, or call next again to get the - first element of the list (or END_LIST if empty). - -
    • BEGIN_MAP - Call getMap() to decodeKeys the entire map, or call next again to get the first - key of the map (or END_MAP if empty). - -
    • END_INPUT - Parsing is finished, close the reader. - -
    • END_LIST - The current list is complete, call next again. - -
    • END_MAP - The current map is complete, call next again. - -
    • BOOLEAN,DOUBLE,LONG,NULL,STRING - Call getElement() or the corresponding getter. - -
    - -

    - - Be aware that if the underlying encoding (such as JSON) doesn't provide a mechanism to - differentiate between data types (such as numbers), values might not get as the same type they - were encoded.

    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeInterface 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 TypeMethod 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.
      -
      DSElementgetElement() -
      Returns the DSElement when last() == raw type or ROOT.
      -
      DSListgetList() -
      This should only be called when last() == BEGIN_LIST and it will decodeKeys the entire - list.
      -
      longgetLong() -
      Returns the value when last() == LONG.
      -
      DSMapgetMap() -
      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.Tokenlast() -
      The last value returned from next().
      -
      DSIReader.Tokennext() -
      Advances the reader to the next item and returns the token representing it's current state.
      -
      DSIReaderreset() -
      Sets last() == ROOT.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        close

        -
        void close()
        -
        Close the input.
        -
        -
        Specified by:
        -
        close in interface java.lang.AutoCloseable
        -
        Specified by:
        -
        close in interface java.io.Closeable
        -
        -
        • -
      - - - -
        -
      • -

        getBoolean

        -
        boolean getBoolean()
        -
        Returns the value when last() == BOOLEAN.
        -
        • -
      - - - -
        -
      • -

        getBytes

        -
        byte[] getBytes()
        -
        Returns the value when last() == BYTES.
        -
        • -
      - - - -
        -
      • -

        getDouble

        -
        double getDouble()
        -
        Returns the value when last() == DOUBLE.
        -
        • -
      - - - -
        -
      • -

        getElement

        -
        DSElement getElement()
        -
        Returns the DSElement when last() == raw type or ROOT.
        -
        • -
      - - - -
        -
      • -

        getLong

        -
        long getLong()
        -
        Returns the value when last() == LONG.
        -
        • -
      - - - -
        -
      • -

        getList

        -
        DSList getList()
        -
        This should only be called when last() == BEGIN_LIST and it will decodeKeys the entire - list. Call next rather than this method to get the list in pieces.
        -
        • -
      - - - -
        -
      • -

        getMap

        -
        DSMap getMap()
        -
        This should only be called when last() == BEGIN_MAP and it will decodeKeys the entire map. - Call next rather than this method get the map in pieces.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        java.lang.String getString()
        -
        Returns the value when last() == STRING.
        -
        • -
      - - - -
        -
      • -

        last

        -
        DSIReader.Token last()
        -
        The last value returned from next(). At the beginning of a document, before next has been - called, this will return ROOT.
        -
        • -
      - - - -
        -
      • -

        next

        -
        DSIReader.Token next()
        -
        Advances the reader to the next item and returns the token representing it's current state.
        -
        • -
      - - - -
        -
      • -

        reset

        -
        DSIReader reset()
        -
        Sets last() == ROOT.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/DSIWriter.html b/docs/javadoc/org/iot/dsa/io/DSIWriter.html deleted file mode 100644 index 677c5878..00000000 --- a/docs/javadoc/org/iot/dsa/io/DSIWriter.html +++ /dev/null @@ -1,606 +0,0 @@ - - - - - -DSIWriter (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.io
-

Interface DSIWriter

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    java.lang.AutoCloseable, java.io.Closeable
    -
    -
    -
    All Known Implementing Classes:
    -
    AbstractJsonWriter, AbstractWriter, JsonAppender, JsonWriter
    -
    -
    -
    -
    public interface DSIWriter
-extends java.io.Closeable
    -
    An encoder that can be used to encode large graphs with or without object instances. - -

    - - To simply encode a DSMap or DSList, use the value(DSElement) method. - - For example: - -

      - -
    • new JsonWriter(out).value(myMap).close(); - -
    - -

    - - Otherwise, you can stream data struct without using any DSIObject instances: - -

      - -
    • out.newMap().key("a").value(1).key("b").value(2).key("c").value(3).endMap(); - -
    - -

    - - Be aware that if the underlying encoding (such as JSON) doesn't provide a mechanism to - differentiate between data types (such as numbers), values might not get as the same type they - were encoded.

    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        beginList

        -
        DSIWriter beginList()
        -
        Start a new list and return this.
        -
        -
        Throws:
        -
        java.lang.IllegalStateException - when improperly called.
        -
        -
        • -
      - - - -
        -
      • -

        beginList

        -
        DSIWriter beginList(int size)
        -
        Start a new list of the given size and return this.
        -
        -
        Parameters:
        -
        size - Less than zero means the size is unknown.
        -
        Throws:
        -
        java.lang.IllegalStateException - when improperly called.
        -
        -
        • -
      - - - -
        -
      • -

        beginMap

        -
        DSIWriter beginMap()
        -
        Start a new map and return this.
        -
        -
        Throws:
        -
        java.lang.IllegalStateException - when improperly called.
        -
        -
        • -
      - - - -
        -
      • -

        beginMap

        -
        DSIWriter beginMap(int size)
        -
        Start a new map of the given size and return this.
        -
        -
        Parameters:
        -
        size - Less than zero means the size is unknown.
        -
        Throws:
        -
        java.lang.IllegalStateException - when improperly called.
        -
        -
        • -
      - - - -
        -
      • -

        close

        -
        void close()
        -
        Close the stream. IOExceptions will be wrapped in runtime exceptions.
        -
        -
        Specified by:
        -
        close in interface java.lang.AutoCloseable
        -
        Specified by:
        -
        close in interface java.io.Closeable
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        flush

        -
        DSIWriter flush()
        -
        Flush the stream. IOExceptions will be wrapped in runtime exceptions.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        length

        -
        int length()
        -
        If the writer is buffering output, this returns the size of that buffer.
        -
        • -
      - - - -
        -
      • -

        reset

        -
        DSIWriter reset()
        -
        Clears the state of the writer.
        -
        • -
      - - - -
        -
      • -

        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(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).
        -
        -
        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/NodeDecoder.html b/docs/javadoc/org/iot/dsa/io/NodeDecoder.html deleted file mode 100644 index ff36ce28..00000000 --- a/docs/javadoc/org/iot/dsa/io/NodeDecoder.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - -NodeDecoder (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.io
-

Class NodeDecoder

-
-
- -
-
    -
  • -
    -
    -
    public class NodeDecoder
-extends java.lang.Object
    -
    Decodes a node (tree) that was encoded with NodeEncoder. - -

    - - This is for storing the configuration database, not for DSA interop.

    -
    -
    See Also:
    -
    NodeEncoder
    -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSNodedecode(DSIReader in) -
      Reads a node tree from the given input.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        decode

        -
        public static DSNode decode(DSIReader in)
        -
        Reads a node tree from the given input.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/NodeEncoder.html b/docs/javadoc/org/iot/dsa/io/NodeEncoder.html deleted file mode 100644 index 693ea57b..00000000 --- a/docs/javadoc/org/iot/dsa/io/NodeEncoder.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - -NodeEncoder (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.io
-

Class NodeEncoder

-
-
- -
-
    -
  • -
    -
    -
    public class NodeEncoder
-extends java.lang.Object
    -
    Encodes a node tree using a compact JSON schema. Defaults are omitted and class names are - tokenized to minimize size. Use NodeDecoder for deserialization. - -

    - - This is for saving a configuration database, not for DSA interop.

    -
    -
    See Also:
    -
    NodeDecoder
    -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSIWriterencode(DSIWriter out, - DSNode node) -
      Writes the node tree to the given writer.
      -
      -
        -
      • - - -

        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/json/AbstractJsonWriter.html b/docs/javadoc/org/iot/dsa/io/json/AbstractJsonWriter.html deleted file mode 100644 index 2f3f03f1..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/AbstractJsonWriter.html +++ /dev/null @@ -1,704 +0,0 @@ - - - - - -AbstractJsonWriter (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.io.json
-

Class AbstractJsonWriter

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AbstractJsonWriter

        -
        public AbstractJsonWriter()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      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)
        -
        Description copied from interface: DSIWriter
        -
        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 in interface DSIWriter
        -
        Overrides:
        -
        value in class AbstractWriter
        -
        -
        • -
      - - - -
        -
      • -

        writeSeparator

        -
        protected void writeSeparator()
-                       throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write a value separator, such as the comma in json.
        -
        -
        Specified by:
        -
        writeSeparator in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - - - - - -
        -
      • -

        write

        -
        protected void write(boolean arg)
-              throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write the value.
        -
        -
        Specified by:
        -
        write in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected void write(byte[] arg)
-              throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write the value.
        -
        -
        Specified by:
        -
        write in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected void write(double arg)
-              throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write the value.
        -
        -
        Specified by:
        -
        write in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected void write(long arg)
-              throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write the value.
        -
        -
        Specified by:
        -
        write in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeKey

        -
        protected void writeKey(java.lang.CharSequence arg)
-                 throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write string key of a map entry.
        -
        -
        Specified by:
        -
        writeKey in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeKeyValueSeparator

        -
        protected void writeKeyValueSeparator()
-                               throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Separate the key from the value in a map.
        -
        -
        Specified by:
        -
        writeKeyValueSeparator in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeListEnd

        -
        protected void writeListEnd()
-                     throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        End the current list.
        -
        -
        Specified by:
        -
        writeListEnd in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeListStart

        -
        protected void writeListStart(int size)
-                       throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Start a new list.
        -
        -
        Specified by:
        -
        writeListStart in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeMapEnd

        -
        protected void writeMapEnd()
-                    throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        End the current map.
        -
        -
        Specified by:
        -
        writeMapEnd in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeMapStart

        -
        protected void writeMapStart(int size)
-                      throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Start a new map.
        -
        -
        Specified by:
        -
        writeMapStart in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeNull

        -
        protected void writeNull()
-                  throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write a null value.
        -
        -
        Specified by:
        -
        writeNull in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        writeValue

        -
        protected void writeValue(java.lang.CharSequence arg)
-                   throws java.io.IOException
        -
        Description copied from class: AbstractWriter
        -
        Write the value, which will never be null.
        -
        -
        Specified by:
        -
        writeValue in class AbstractWriter
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/json/JsonAppender.html b/docs/javadoc/org/iot/dsa/io/json/JsonAppender.html deleted file mode 100644 index df5445ef..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/JsonAppender.html +++ /dev/null @@ -1,632 +0,0 @@ - - - - - -JsonAppender (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.io.json
-

Class JsonAppender

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Closeable, java.lang.Appendable, java.lang.AutoCloseable, DSIWriter, JsonConstants
    -
    -
    -
    -
    public class JsonAppender
-extends AbstractJsonWriter
    -
    Json implementation of DSWriter intended for Appendables such as StringBuilders. This can be used - for OutputStreams and Writers as well, but DSWriter will be faster.

    The same instance can be - reused with the setOutput methods.

    This class is not thread safe.

    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JsonAppender

        -
        public JsonAppender()
        -
        Be sure to call one of the setOutput methods.
        -
        • -
      - - - -
        -
      • -

        JsonAppender

        -
        public JsonAppender(java.lang.Appendable arg)
        -
        Will write directly to the given appendable.
        -
        • -
      - - - -
        -
      • -

        JsonAppender

        -
        public JsonAppender(java.io.File arg)
        -
        Creates an underlying FileWriter.
        -
        • -
      - - - -
        -
      • -

        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 arg)
        -
        Creates an underlying OutputStreamWriter.
        -
        • -
      - - - -
        -
      • -

        JsonAppender

        -
        public JsonAppender(java.io.OutputStream out,
-                    java.lang.String zipFileName)
        -
        Will write a zip file to the given stream.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        append

        -
        public java.lang.Appendable append(char ch)
        -
        Append the char and return this. Can be used for custom formatting.
        -
        • -
      - - - -
        -
      • -

        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 in class AbstractJsonWriter
        -
        -
        • -
      - - - -
        -
      • -

        append

        -
        public java.lang.Appendable append(java.lang.CharSequence csq)
        -
        Append the chars and return this. Can be used for custom formatting.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        close

        -
        public void close()
        -
        Description copied from interface: DSIWriter
        -
        Close the stream. IOExceptions will be wrapped in runtime exceptions.
        -
        • -
      - - - -
        -
      • -

        flush

        -
        public JsonAppender flush()
        -
        Description copied from interface: DSIWriter
        -
        Flush the stream. IOExceptions will be wrapped in runtime exceptions.
        -
        • -
      - - - -
        -
      • -

        isZip

        -
        public boolean isZip()
        -
        Whether or not this is zipping the output.
        -
        • -
      - - - - - - - -
        -
      • -

        setOutput

        -
        public JsonAppender setOutput(java.lang.Appendable arg)
        -
        Sets the sink, resets the state and returns this.
        -
        • -
      - - - -
        -
      • -

        setOutput

        -
        public JsonAppender setOutput(java.io.File 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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/json/JsonConstants.html b/docs/javadoc/org/iot/dsa/io/json/JsonConstants.html deleted file mode 100644 index 5d6bd523..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/JsonConstants.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - -JsonConstants (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.io.json
-

Interface JsonConstants

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField 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"
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        DBL_NAN

        -
        static final java.lang.String DBL_NAN
        -
        How Double.NaN is encoded: "\\u001BNaN"
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        DBL_NEG_INF

        -
        static final java.lang.String DBL_NEG_INF
        -
        How Double.NEGATIVE_INFINITY is encoded: "\\u001B-Infinity"
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        DBL_POS_INF

        -
        static final java.lang.String DBL_POS_INF
        -
        How Double.POSITIVE_INFINITY is encoded: "\\u001BInfinity"
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/json/JsonReader.html b/docs/javadoc/org/iot/dsa/io/json/JsonReader.html deleted file mode 100644 index 77f2bb1c..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/JsonReader.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - -JsonReader (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.io.json
-

Class JsonReader

-
-
- -
-
    -
  • -
    -
    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
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JsonReader

        -
        public JsonReader()
        -
        • -
      - - - -
        -
      • -

        JsonReader

        -
        public JsonReader(java.lang.CharSequence in)
        -
        • -
      - - - -
        -
      • -

        JsonReader

        -
        public JsonReader(java.io.File file)
        -
        • -
      - - - -
        -
      • -

        JsonReader

        -
        public JsonReader(java.io.InputStream in,
-                  java.lang.String charset)
        -
        • -
      - - - -
        -
      • -

        JsonReader

        -
        public JsonReader(java.io.Reader in)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        close

        -
        public void close()
        -
        Description copied from interface: DSIReader
        -
        Close the input.
        -
        -
        Specified by:
        -
        close in interface java.io.Closeable
        -
        Specified by:
        -
        close in interface java.lang.AutoCloseable
        -
        Specified by:
        -
        close in interface DSIReader
        -
        -
        • -
      - - - -
        -
      • -

        next

        -
        public DSIReader.Token next()
        -
        Description copied from class: AbstractReader
        -
        Subclasses must override this, read the next item from the stream, then call one of the - setXxx methods. - -

        - - Advances the reader to the next item and returns the token representing it's current state.

        -
        -
        Specified by:
        -
        next in interface DSIReader
        -
        Specified by:
        -
        next in class AbstractReader
        -
        -
        • -
      - - - - - - - -
        -
      • -

        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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/json/JsonWriter.html b/docs/javadoc/org/iot/dsa/io/json/JsonWriter.html deleted file mode 100644 index 12af5d67..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/JsonWriter.html +++ /dev/null @@ -1,626 +0,0 @@ - - - - - -JsonWriter (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.io.json
-

Class JsonWriter

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Closeable, java.lang.Appendable, java.lang.AutoCloseable, DSIWriter, JsonConstants
    -
    -
    -
    -
    public class JsonWriter
-extends AbstractJsonWriter
    -
    Json implementation of DSWriter intended for OutputStreams and Writers. While JsonAppender can - also handle OutputStreams and Writer, this is more performant.

    The same instance can be reused - with the setOutput methods.

    This class is not thread safe.

    -
    -
    See Also:
    -
    DSIWriter
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JsonWriter

        -
        public JsonWriter()
        -
        Be sure to call one of the setOutput methods.
        -
        • -
      - - - -
        -
      • -

        JsonWriter

        -
        public JsonWriter(java.io.File arg)
        -
        Creates an underlying FileWriter.
        -
        • -
      - - - -
        -
      • -

        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 arg)
        -
        Creates an underlying OutputStreamWriter.
        -
        • -
      - - - -
        -
      • -

        JsonWriter

        -
        public JsonWriter(java.io.OutputStream out,
-                  java.lang.String zipFileName)
        -
        Will write a zip file to the given stream.
        -
        • -
      - - - -
        -
      • -

        JsonWriter

        -
        public JsonWriter(java.io.Writer out)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        close

        -
        public void close()
        -
        Description copied from interface: DSIWriter
        -
        Close the stream. IOExceptions will be wrapped in runtime exceptions.
        -
        • -
      - - - -
        -
      • -

        flush

        -
        public JsonWriter flush()
        -
        Description copied from interface: DSIWriter
        -
        Flush the stream. IOExceptions will be wrapped in runtime exceptions.
        -
        • -
      - - - - - - - -
        -
      • -

        setOutput

        -
        public JsonWriter setOutput(java.io.File arg)
        -
        Sets the sink, resets the state and returns this.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        setOutput

        -
        public JsonWriter setOutput(java.io.Writer out)
        -
        Sets the sink, resets the state and returns this.
        -
        • -
      - - - -
        -
      • -

        append

        -
        public java.lang.Appendable append(java.lang.CharSequence csq)
-                            throws java.io.IOException
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        append

        -
        public java.lang.Appendable append(char ch)
-                            throws java.io.IOException
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
        • -
      - - - -
        -
      • -

        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
        -
        -
        • -
      - - - -
        -
      • -

        append

        -
        public AbstractJsonWriter append(char[] ch,
-                                 int off,
-                                 int len)
        -
        Append the chars and return this. Can be used for custom formatting.
        -
        -
        Specified by:
        -
        append in class AbstractJsonWriter
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/json/package-frame.html b/docs/javadoc/org/iot/dsa/io/json/package-frame.html deleted file mode 100644 index 6a5510e3..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/package-frame.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - -org.iot.dsa.io.json (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.io.json

-
-

Interfaces

- -

Classes

- -
- - diff --git a/docs/javadoc/org/iot/dsa/io/json/package-summary.html b/docs/javadoc/org/iot/dsa/io/json/package-summary.html deleted file mode 100644 index 14f76e2a..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/package-summary.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - -org.iot.dsa.io.json (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.io.json

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/json/package-tree.html b/docs/javadoc/org/iot/dsa/io/json/package-tree.html deleted file mode 100644 index 4127d23d..00000000 --- a/docs/javadoc/org/iot/dsa/io/json/package-tree.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -org.iot.dsa.io.json Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.io.json

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/package-frame.html b/docs/javadoc/org/iot/dsa/io/package-frame.html deleted file mode 100644 index 9d00c593..00000000 --- a/docs/javadoc/org/iot/dsa/io/package-frame.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - -org.iot.dsa.io (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.io

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/docs/javadoc/org/iot/dsa/io/package-summary.html b/docs/javadoc/org/iot/dsa/io/package-summary.html deleted file mode 100644 index e25f335a..00000000 --- a/docs/javadoc/org/iot/dsa/io/package-summary.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - -org.iot.dsa.io (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.io

-
-
Node serialization and streaming abstraction for JSON and MsgPack.
-
-

See: Description

-
-
- - - - -

Package org.iot.dsa.io Description

-
Node serialization and streaming abstraction for JSON and MsgPack.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/io/package-tree.html b/docs/javadoc/org/iot/dsa/io/package-tree.html deleted file mode 100644 index 104eb5d8..00000000 --- a/docs/javadoc/org/iot/dsa/io/package-tree.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - -org.iot.dsa.io Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.io

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/AsyncLogHandler.html b/docs/javadoc/org/iot/dsa/logging/AsyncLogHandler.html deleted file mode 100644 index 48abf227..00000000 --- a/docs/javadoc/org/iot/dsa/logging/AsyncLogHandler.html +++ /dev/null @@ -1,479 +0,0 @@ - - - - - -AsyncLogHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.logging
-

Class AsyncLogHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSILevels
    -
    -
    -
    Direct Known Subclasses:
    -
    FileLogHandler, PrintStreamLogHandler
    -
    -
    -
    -
    public abstract class AsyncLogHandler
-extends java.util.logging.Handler
-implements DSILevels
    -
    Enqueues logging records which are then processed by separate thread.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      AsyncLogHandler() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod 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(java.util.logging.LogRecord record) -
      Enqueues the record for the write thread.
      -
      AsyncLogHandlersetMaxQueueSize(int maxQueueSize) 
      protected AsyncLogHandlersetOut(java.io.PrintStream out) -
      Sets the sink for formatted messages.
      -
      protected voidstart() -
      This must be called for the handler to actually do anything.
      -
      protected voidwrite(java.util.logging.LogRecord record) -
      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

      - - - -
        -
      • -

        close

        -
        public void close()
        -
        Closes the PrintStream, terminates the write thread and performs houseKeeping.
        -
        -
        Specified by:
        -
        close in class java.util.logging.Handler
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        getOut

        -
        protected java.io.PrintStream getOut()
        -
        The sink for formatted messages.
        -
        • -
      - - - -
        -
      • -

        getThreadName

        -
        protected abstract java.lang.String getThreadName()
        -
        Used to name the thread that processes logging records.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        publish

        -
        public void publish(java.util.logging.LogRecord record)
        -
        Enqueues the record for the write thread.
        -
        -
        Specified by:
        -
        publish in class java.util.logging.Handler
        -
        -
        • -
      - - - -
        -
      • -

        setMaxQueueSize

        -
        public AsyncLogHandler setMaxQueueSize(int maxQueueSize)
        -
        • -
      - - - -
        -
      • -

        setOut

        -
        protected AsyncLogHandler setOut(java.io.PrintStream out)
        -
        Sets the sink for formatted messages.
        -
        • -
      - - - -
        -
      • -

        start

        -
        protected void start()
        -
        This must be called for the handler to actually do anything. Starts the write thread if there - isn't already an active write thread.
        -
        • -
      - - - -
        -
      • -

        write

        -
        protected void write(java.util.logging.LogRecord record)
        -
        Formats and writes the logging record the underlying stream.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/DSILevels.html b/docs/javadoc/org/iot/dsa/logging/DSILevels.html deleted file mode 100644 index e2c7a506..00000000 --- a/docs/javadoc/org/iot/dsa/logging/DSILevels.html +++ /dev/null @@ -1,487 +0,0 @@ - - - - - -DSILevels (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.logging
-

Interface DSILevels

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField 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 
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        -
      • -

        all

        -
        static final java.util.logging.Level all
        -
        • -
      - - - -
        -
      • -

        trace

        -
        static final java.util.logging.Level trace
        -
        • -
      - - - -
        -
      • -

        debug

        -
        static final java.util.logging.Level debug
        -
        • -
      - - - -
        -
      • -

        fine

        -
        static final java.util.logging.Level fine
        -
        • -
      - - - -
        -
      • -

        warn

        -
        static final java.util.logging.Level warn
        -
        • -
      - - - -
        -
      • -

        info

        -
        static final java.util.logging.Level info
        -
        • -
      - - - -
        -
      • -

        error

        -
        static final java.util.logging.Level error
        -
        • -
      - - - -
        -
      • -

        admin

        -
        static final java.util.logging.Level admin
        -
        • -
      - - - -
        -
      • -

        fatal

        -
        static final java.util.logging.Level fatal
        -
        • -
      - - - -
        -
      • -

        off

        -
        static final java.util.logging.Level off
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/DSLogger.html b/docs/javadoc/org/iot/dsa/logging/DSLogger.html deleted file mode 100644 index 8c1c9851..00000000 --- a/docs/javadoc/org/iot/dsa/logging/DSLogger.html +++ /dev/null @@ -1,737 +0,0 @@ - - - - - -DSLogger (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.logging
-

Class DSLogger

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSILevels
    -
    -
    -
    Direct Known Subclasses:
    -
    DSNode
    -
    -
    -
    -
    public class DSLogger
-extends java.lang.Object
-implements DSILevels
    -
    Adds an abstraction layer on Java Util Logging for two purposes: - -
      - -
    • To use the DSA levels. - -
    • So JUL can be replaced with other logging frameworks if desired. - -
    - - This has methods that enables conditional logging (most efficient) using ternary statements. - -

    - - Without this class: - - 

    -
- 
- if (myLogger.isLoggable(Level.INFO))
-     myLogger.info(someMessage());
- 
-
-
    - - With this class: - - 
    -
- 
- info(info() ? someMessage() : null);
- 
-
-
    - -

    - - DSA defines levels differently than JUL, however, all JUL levels will be mapped / formatted - for DSA. Level guidelines: - -

      - -
    • trace() = DSA trace = JUL finest - -
    • debug() = DSA debug = JUL finer - -
    • fine() = DSA info = JUL fine, config - -
    • warn() = DSA warn = Custom level - -
    • info() = DSA sys = JUL info - -
    • error() = DSA error = JUL warning - -
    • admin() = DSA admin = Custom level - -
    • fatal() = DSA fatal = JUL severe - -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSLogger() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanadmin() -
      True if the level is loggable.
      -
      voidadmin(java.lang.Object msg) 
      voidadmin(java.lang.Object msg, - java.lang.Throwable x) 
      booleandebug() -
      True if the level is loggable.
      -
      voiddebug(java.lang.Object msg) -
      Log a debug event.
      -
      voiddebug(java.lang.Object msg, - java.lang.Throwable x) -
      Log a debug event.
      -
      booleanerror() -
      True if the level is loggable.
      -
      voiderror(java.lang.Object msg) 
      voiderror(java.lang.Object msg, - java.lang.Throwable x) 
      booleanfatal() -
      True if the level is loggable.
      -
      voidfatal(java.lang.Object msg) 
      voidfatal(java.lang.Object msg, - java.lang.Throwable x) 
      booleanfine() -
      True if the level is loggable.
      -
      voidfine(java.lang.Object msg) -
      Log a frequent event.
      -
      voidfine(java.lang.Object msg, - java.lang.Throwable x) -
      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(java.lang.Object msg) -
      Log an infrequent major lifecycle event.
      -
      voidinfo(java.lang.Object msg, - java.lang.Throwable x) -
      Log an infrequent major lifecycle event.
      -
      booleantrace() -
      True if the level is loggable.
      -
      voidtrace(java.lang.Object msg) -
      Log a trace or verbose event.
      -
      voidtrace(java.lang.Object msg, - java.lang.Throwable x) -
      Log a trace or verbose event.
      -
      booleanwarn() -
      True if the level is loggable.
      -
      voidwarn(java.lang.Object msg) -
      Log an unusual but not critical event.
      -
      voidwarn(java.lang.Object msg, - java.lang.Throwable x) -
      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

      - - - -
        -
      • -

        getLogName

        -
        protected java.lang.String getLogName()
        -
        Override point, returns the simple class name by default.
        -
        • -
      - - - -
        -
      • -

        trace

        -
        public boolean trace()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        trace

        -
        public void trace(java.lang.Object msg)
        -
        Log a trace or verbose event.
        -
        • -
      - - - -
        -
      • -

        trace

        -
        public void trace(java.lang.Object msg,
-                  java.lang.Throwable x)
        -
        Log a trace or verbose event.
        -
        • -
      - - - -
        -
      • -

        debug

        -
        public boolean debug()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        debug

        -
        public void debug(java.lang.Object msg)
        -
        Log a debug event.
        -
        • -
      - - - -
        -
      • -

        debug

        -
        public void debug(java.lang.Object msg,
-                  java.lang.Throwable x)
        -
        Log a debug event.
        -
        • -
      - - - -
        -
      • -

        fine

        -
        public boolean fine()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        fine

        -
        public void fine(java.lang.Object msg)
        -
        Log a frequent event.
        -
        • -
      - - - -
        -
      • -

        fine

        -
        public void fine(java.lang.Object msg,
-                 java.lang.Throwable x)
        -
        Log a frequent event.
        -
        • -
      - - - -
        -
      • -

        warn

        -
        public boolean warn()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        warn

        -
        public void warn(java.lang.Object msg)
        -
        Log an unusual but not critical event.
        -
        • -
      - - - -
        -
      • -

        warn

        -
        public void warn(java.lang.Object msg,
-                 java.lang.Throwable x)
        -
        Log an unusual but not critical event.
        -
        • -
      - - - -
        -
      • -

        info

        -
        public boolean info()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        info

        -
        public void info(java.lang.Object msg)
        -
        Log an infrequent major lifecycle event.
        -
        • -
      - - - -
        -
      • -

        info

        -
        public void info(java.lang.Object msg,
-                 java.lang.Throwable x)
        -
        Log an infrequent major lifecycle event.
        -
        • -
      - - - -
        -
      • -

        error

        -
        public boolean error()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        error

        -
        public void error(java.lang.Object msg)
        -
        • -
      - - - -
        -
      • -

        error

        -
        public void error(java.lang.Object msg,
-                  java.lang.Throwable x)
        -
        • -
      - - - -
        -
      • -

        admin

        -
        public boolean admin()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        admin

        -
        public void admin(java.lang.Object msg)
        -
        • -
      - - - -
        -
      • -

        admin

        -
        public void admin(java.lang.Object msg,
-                  java.lang.Throwable x)
        -
        • -
      - - - -
        -
      • -

        fatal

        -
        public boolean fatal()
        -
        True if the level is loggable.
        -
        • -
      - - - -
        -
      • -

        fatal

        -
        public void fatal(java.lang.Object msg)
        -
        • -
      - - - -
        -
      • -

        fatal

        -
        public void fatal(java.lang.Object msg,
-                  java.lang.Throwable x)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/DSLogging.html b/docs/javadoc/org/iot/dsa/logging/DSLogging.html deleted file mode 100644 index cd3be29a..00000000 --- a/docs/javadoc/org/iot/dsa/logging/DSLogging.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - -DSLogging (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.logging
-

Class DSLogging

-
-
- -
-
    -
  • -
    -
    -
    public class DSLogging
-extends java.lang.Object
    -
    Static utilities for configuring the logging subsystem.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField 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 TypeMethod and Description
      static voidclose() -
      Closes all async log handlers.
      -
      static java.util.logging.LoggergetDefaultLogger() -
      The default logger.
      -
      static java.util.logging.LoggergetLogger(java.lang.String name, - java.io.File logFile) -
      Adds a FileLogHandler to the named logger, if there isn't one already.
      -
      static voidsetDefaultLevel(java.util.logging.Level level) 
      -
        -
      • - - -

        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.
        -
        • -
      - - - -
        -
      • -

        DEFAULT_MAX_BACKUPS

        -
        public static int DEFAULT_MAX_BACKUPS
        -
        The default number of backups to retain: 10 by default.
        -
        • -
      - - - -
        -
      • -

        DEFAULT_MAX_QUEUE

        -
        public static int DEFAULT_MAX_QUEUE
        -
        Max async queue size: 2500 by default.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        close

        -
        public static void close()
        -
        Closes all async log handlers.
        -
        • -
      - - - -
        -
      • -

        getDefaultLogger

        -
        public static java.util.logging.Logger getDefaultLogger()
        -
        The default logger.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        setDefaultLevel

        -
        public static void setDefaultLevel(java.util.logging.Level level)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/FileLogHandler.html b/docs/javadoc/org/iot/dsa/logging/FileLogHandler.html deleted file mode 100644 index aa0b1c15..00000000 --- a/docs/javadoc/org/iot/dsa/logging/FileLogHandler.html +++ /dev/null @@ -1,424 +0,0 @@ - - - - - -FileLogHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.logging
-

Class FileLogHandler

-
-
- -
-
    -
  • -
    -
    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.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      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.
        -
        • -
      - - - -
        -
      • -

        getMaxBackups

        -
        public int getMaxBackups()
        -
        The number of backup files to retain.
        -
        • -
      - - - -
        -
      • -

        getThreadName

        -
        public java.lang.String getThreadName()
        -
        Description copied from class: AsyncLogHandler
        -
        Used to name the thread that processes logging records.
        -
        -
        Specified by:
        -
        getThreadName in class AsyncLogHandler
        -
        -
        • -
      - - - -
        -
      • -

        houseKeeping

        -
        protected void houseKeeping()
        -
        Description copied from class: AsyncLogHandler
        -
        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 in class 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.
        -
        • -
      - - - -
        -
      • -

        setBackupThreshold

        -
        public FileLogHandler setBackupThreshold(int arg)
        -
        The file size threshold after which a logging file will be backed up and cleared.
        -
        • -
      - - - -
        -
      • -

        setMaxBackups

        -
        public FileLogHandler setMaxBackups(int arg)
        -
        The default is 10.
        -
        • -
      - - - -
        -
      • -

        trimBackups

        -
        public void trimBackups()
        -
        Only public for testing, do not call. Deletes old zipped up logs.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/PrintStreamLogHandler.html b/docs/javadoc/org/iot/dsa/logging/PrintStreamLogHandler.html deleted file mode 100644 index f5ce1d6b..00000000 --- a/docs/javadoc/org/iot/dsa/logging/PrintStreamLogHandler.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - -PrintStreamLogHandler (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.logging
-

Class PrintStreamLogHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSILevels
    -
    -
    -
    -
    public class PrintStreamLogHandler
-extends AsyncLogHandler
    -
    Async logging handler for writing to streams such as System.out.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        PrintStreamLogHandler

        -
        public PrintStreamLogHandler(java.lang.String name,
-                             java.io.PrintStream out)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getThreadName

        -
        public java.lang.String getThreadName()
        -
        Description copied from class: AsyncLogHandler
        -
        Used to name the thread that processes logging records.
        -
        -
        Specified by:
        -
        getThreadName in class AsyncLogHandler
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/package-frame.html b/docs/javadoc/org/iot/dsa/logging/package-frame.html deleted file mode 100644 index 5849292a..00000000 --- a/docs/javadoc/org/iot/dsa/logging/package-frame.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - -org.iot.dsa.logging (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.logging

-
-

Interfaces

- -

Classes

- -
- - diff --git a/docs/javadoc/org/iot/dsa/logging/package-summary.html b/docs/javadoc/org/iot/dsa/logging/package-summary.html deleted file mode 100644 index 768af9b9..00000000 --- a/docs/javadoc/org/iot/dsa/logging/package-summary.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - -org.iot.dsa.logging (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.logging

-
-
Async handler for Java Util Logging that also manages log backups.
-
-

See: Description

-
-
- - - - -

Package org.iot.dsa.logging Description

-
Async handler for Java Util Logging that also manages log backups.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/logging/package-tree.html b/docs/javadoc/org/iot/dsa/logging/package-tree.html deleted file mode 100644 index 81df23c0..00000000 --- a/docs/javadoc/org/iot/dsa/logging/package-tree.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - -org.iot.dsa.logging Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.logging

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSBool.html b/docs/javadoc/org/iot/dsa/node/DSBool.html deleted file mode 100644 index b81de0d1..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSBool.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - - -DSBool (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSBool

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        TRUE

        -
        public static final DSBool TRUE
        -
        • -
      - - - -
        -
      • -

        FALSE

        -
        public static final DSBool FALSE
        -
        • -
      - - - -
        -
      • -

        NULL

        -
        public static final DSBool NULL
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isBoolean

        -
        public boolean isBoolean()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a boolean.
        -
        -
        Overrides:
        -
        isBoolean in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents null.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        Overrides:
        -
        isNull in class DSElement
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        toBoolean

        -
        public boolean toBoolean()
        -
        Description copied from class: DSElement
        -
        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 in interface DSIBoolean
        -
        Overrides:
        -
        toBoolean in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toDouble

        -
        public double toDouble()
        -
        0 or 1.
        -
        -
        Overrides:
        -
        toDouble in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toFloat

        -
        public float toFloat()
        -
        0 or 1.
        -
        -
        Overrides:
        -
        toFloat in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toInt

        -
        public int toInt()
        -
        0 or 1.
        -
        -
        Overrides:
        -
        toInt in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toLong

        -
        public long toLong()
        -
        0 or 1.
        -
        -
        Overrides:
        -
        toLong in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSBool valueOf(boolean arg)
        -
        Will return either TRUE or FALSE.
        -
        • -
      - - - - - - - -
        -
      • -

        valueOf

        -
        public static DSBool valueOf(java.lang.String arg)
        -
        Will return NULL, TRUE or FALSE.
        -
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If the string cannot be decoded.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSBytes.html b/docs/javadoc/org/iot/dsa/node/DSBytes.html deleted file mode 100644 index eb103e4e..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSBytes.html +++ /dev/null @@ -1,1161 +0,0 @@ - - - - - -DSBytes (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSBytes

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject, DSIValue
    -
    -
    -
    -
    public class DSBytes
-extends DSElement
    -
    Byte array that gets encoded as a base64 string.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSBytesNULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static byte[]decode(java.lang.String encoded) 
      static java.lang.Stringencode(byte[] bytes) 
      booleanequals(java.lang.Object arg) -
      True if the argument is a DSINumber and the values are equal or they are both isNull.
      -
      static byte[]fromHex(java.lang.CharSequence s) -
      Converts a hex string into a byte array.
      -
      byte[]getBytes() -
      The raw bytes, do not modify.
      -
      DSElementTypegetElementType() -
      For switch statements.
      -
      DSValueTypegetValueType() -
      The DSA value type mapping.
      -
      inthashCode() 
      booleanisBytes() -
      Whether or not the object represents a byte array.
      -
      static booleanisBytes(java.lang.String arg) -
      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(byte[] buf, - int off, - boolean bigEndian) -
      Reads the primitive from a byte array.
      -
      static doublereadDouble(java.io.InputStream in, - boolean bigEndian) -
      Reads the primitive from a stream.
      -
      static floatreadFloat(byte[] buf, - int off, - boolean bigEndian) -
      Reads the primitive from a byte array.
      -
      static floatreadFloat(java.io.InputStream in, - boolean bigEndian) -
      Reads the primitive a stream
      -
      static intreadInt(byte[] buf, - int off, - boolean bigEndian) -
      Reads the primitive from a byte array.
      -
      static intreadInt(java.io.InputStream in, - boolean bigEndian) -
      Reads the primitive from a stream.
      -
      static longreadLong(byte[] buf, - int off, - boolean bigEndian) -
      Reads the primitive from a byte array.
      -
      static longreadLong(java.io.InputStream in, - boolean bigEndian) -
      Reads the primitive from a stream.
      -
      static shortreadShort(byte[] buf, - int off, - boolean bigEndian) -
      Reads the primitive from a byte array.
      -
      static shortreadShort(java.io.InputStream in, - boolean bigEndian) -
      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(byte[] bytes, - java.lang.StringBuilder buf) -
      Converts the bytes into a hex string.
      -
      static java.lang.StringBuildertoHex(byte val, - java.lang.StringBuilder buf) -
      Converts the bytes into a hex string.
      -
      java.lang.StringtoString() -
      If isNull(), returns "null", otherwise returns toElement().toString()
      -
      static DSBytesvalueOf(byte[] arg) 
      DSBytesvalueOf(DSElement arg) -
      Returns the argument.
      -
      static DSBytesvalueOf(java.lang.String arg) -
      Decodes a base64 encoded byte array.
      -
      static voidwriteDouble(double v, - byte[] buf, - int off, - boolean bigEndian) -
      Encodes the primitive into a byte array.
      -
      static voidwriteDouble(double v, - java.io.OutputStream out, - boolean bigEndian) -
      Encodes the primitive into a stream.
      -
      static voidwriteFloat(float v, - byte[] buf, - int off, - boolean bigEndian) -
      Encodes the primitive into a byte array.
      -
      static voidwriteFloat(float v, - java.io.OutputStream out, - boolean bigEndian) -
      Encodes the primitive into a stream
      -
      static voidwriteInt(int v, - byte[] buf, - int off, - boolean bigEndian) -
      Encodes the primitive into a byte array.
      -
      static voidwriteInt(int v, - java.io.OutputStream out, - boolean bigEndian) -
      Encodes the primitive into a stream.
      -
      static voidwriteLong(long v, - byte[] buf, - int off, - boolean bigEndian) -
      Encodes the primitive into a byte array.
      -
      static voidwriteLong(long v, - java.io.OutputStream out, - boolean bigEndian) -
      Encodes the primitive into a stream.
      -
      static voidwriteShort(short v, - byte[] buf, - int off, - boolean bigEndian) -
      Encodes the primitive into a byte array.
      -
      static voidwriteShort(short v, - java.io.OutputStream out, - boolean bigEndian) -
      Encodes the primitive into a stream.
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NULL

        -
        public static final DSBytes NULL
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        decode

        -
        public static byte[] decode(java.lang.String encoded)
        -
        • -
      - - - -
        -
      • -

        encode

        -
        public static java.lang.String encode(byte[] bytes)
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        True if the argument is a DSINumber and the values are equal or they are both isNull.
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        fromHex

        -
        public static byte[] fromHex(java.lang.CharSequence s)
        -
        Converts a hex string into a byte array.
        -
        • -
      - - - -
        -
      • -

        getBytes

        -
        public byte[] getBytes()
        -
        The raw bytes, do not modify.
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isBytes

        -
        public boolean isBytes()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a byte array.
        -
        -
        Overrides:
        -
        isBytes in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        isBytes

        -
        public static boolean isBytes(java.lang.String arg)
        -
        True if the string starts with the DSA escape sequence for a base 64 encoded string.
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents null.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        Overrides:
        -
        isNull in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        length

        -
        public int length()
        -
        The number of bytes in the array.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        toBytes

        -
        public byte[] toBytes()
        -
        Description copied from class: DSElement
        -
        Returns the raw byte array for DSBytes only, which should not be modified.
        -
        -
        Overrides:
        -
        toBytes in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        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 in class DSValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSBytes valueOf(byte[] arg)
        -
        • -
      - - - - - - - -
        -
      • -

        valueOf

        -
        public static DSBytes valueOf(java.lang.String arg)
        -
        Decodes a base64 encoded byte array.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSDouble.html b/docs/javadoc/org/iot/dsa/node/DSDouble.html deleted file mode 100644 index ff7fc440..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSDouble.html +++ /dev/null @@ -1,696 +0,0 @@ - - - - - -DSDouble (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSDouble

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NULL

        -
        public static final DSDouble NULL
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        True if the argument is a DSINumber and the values are equal or they are both isNull.
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isDouble

        -
        public boolean isDouble()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a double.
        -
        -
        Specified by:
        -
        isDouble in interface DSINumber
        -
        Overrides:
        -
        isDouble in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        isInfinite

        -
        public boolean isInfinite()
        -
        -
        See Also:
        -
        Double.isInfinite()
        -
        -
        • -
      - - - -
        -
      • -

        isNaN

        -
        public boolean isNaN()
        -
        -
        See Also:
        -
        Double.isNaN()
        -
        -
        • -
      - - - -
        -
      • -

        isNumber

        -
        public boolean isNumber()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a number.
        -
        -
        Overrides:
        -
        isNumber in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents null.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        Overrides:
        -
        isNull in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toBoolean

        -
        public boolean toBoolean()
        -
        Description copied from class: DSElement
        -
        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 in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toDouble

        -
        public double toDouble()
        -
        Description copied from class: DSElement
        -
        Attempts to return a double value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toDouble in interface DSINumber
        -
        Overrides:
        -
        toDouble in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toFloat

        -
        public float toFloat()
        -
        Description copied from class: DSElement
        -
        Attempts to return a float value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toFloat in interface DSINumber
        -
        Overrides:
        -
        toFloat in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toInt

        -
        public int toInt()
        -
        Description copied from class: DSElement
        -
        Attempts to return an int value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toInt in interface DSINumber
        -
        Overrides:
        -
        toInt in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toLong

        -
        public long toLong()
        -
        Description copied from class: DSElement
        -
        Attempts to return a long value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toLong in interface DSINumber
        -
        Overrides:
        -
        toLong in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toNumber

        -
        public java.lang.Number toNumber()
        -
        Description copied from interface: DSINumber
        -
        Returns the Java primitive wrapper.
        -
        -
        Specified by:
        -
        toNumber in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSDouble valueOf(double arg)
        -
        Attempts to reuse some common values before creating a new instance.
        -
        • -
      - - - - - - - -
        -
      • -

        valueOf

        -
        public static DSDouble valueOf(java.lang.String arg)
        -
        Checks for null, then uses Double.parseDouble()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSElement.html b/docs/javadoc/org/iot/dsa/node/DSElement.html deleted file mode 100644 index 472c5556..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSElement.html +++ /dev/null @@ -1,882 +0,0 @@ - - - - - -DSElement (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSElement

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSElement() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DSElementcopy() -
      If an object is mutable (list or map) then this should clone it, immutable objects can simply - return themselves.
      -
      abstract DSElementTypegetElementType() -
      For switch statements.
      -
      abstract DSValueTypegetValueType() -
      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(java.lang.Object obj) -
      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 DSElementmake(boolean arg) -
      Creates an DSIObject representation of the primitive.
      -
      static DSElementmake(byte[] arg) -
      Creates an DSIObject representation of the primitive.
      -
      static DSElementmake(double arg) -
      Creates an DSIObject representation of the primitive.
      -
      static DSElementmake(int arg) -
      Creates an DSIObject representation of the primitive.
      -
      static DSElementmake(long arg) -
      Creates an DSIObject representation of the primitive.
      -
      static DSElementmake(java.lang.String arg) -
      Creates an DSIObject representation of the primitive.
      -
      static DSElementmakeNull() -
      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.
      -
      DSElementtoElement() -
      Returns this.
      -
      floattoFloat() -
      Attempts to return a float value.
      -
      DSGrouptoGroup() -
      Lists and maps return themselves, everything else results in an exception.
      -
      inttoInt() -
      Attempts to return an int value.
      -
      DSListtoList() -
      Lists return themselves, everything else results in an exception.
      -
      longtoLong() -
      Attempts to return a long value.
      -
      DSMaptoMap() -
      Maps return themselves, everything else results in an exception.
      -
      DSIValuevalueOf(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

      - - - -
        -
      • -

        copy

        -
        public DSElement copy()
        -
        If an object is mutable (list or map) then this should clone it, immutable objects can simply - return themselves.
        -
        -
        Specified by:
        -
        copy in interface DSIObject
        -
        Overrides:
        -
        copy in class DSValue
        -
        -
        • -
      - - - -
        -
      • -

        getElementType

        -
        public abstract DSElementType getElementType()
        -
        For switch statements.
        -
        • -
      - - - -
        -
      • -

        getValueType

        -
        public abstract DSValueType getValueType()
        -
        The DSA value type mapping.
        -
        • -
      - - - -
        -
      • -

        isBoolean

        -
        public boolean isBoolean()
        -
        Whether or not the object represents a boolean.
        -
        • -
      - - - -
        -
      • -

        isBytes

        -
        public boolean isBytes()
        -
        Whether or not the object represents a byte array.
        -
        • -
      - - - -
        -
      • -

        isDouble

        -
        public boolean isDouble()
        -
        Whether or not the object represents a double.
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        • -
      - - - -
        -
      • -

        isFloat

        -
        public boolean isFloat()
        -
        Whether or not the object represents a float.
        -
        • -
      - - - -
        -
      • -

        isInt

        -
        public boolean isInt()
        -
        Whether or not the object represents an int.
        -
        • -
      - - - -
        -
      • -

        isGroup

        -
        public boolean isGroup()
        -
        Whether or not the object represents a list or map.
        -
        • -
      - - - -
        -
      • -

        isList

        -
        public boolean isList()
        -
        Whether or not the object represents a list.
        -
        • -
      - - - -
        -
      • -

        isLong

        -
        public boolean isLong()
        -
        Whether or not the object represents a long.
        -
        • -
      - - - -
        -
      • -

        isMap

        -
        public boolean isMap()
        -
        Whether or not the object represents a amp.
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Whether or not the object represents null.
        -
        • -
      - - - -
        -
      • -

        isNumber

        -
        public boolean isNumber()
        -
        Whether or not the object represents a number.
        -
        • -
      - - - -
        -
      • -

        isString

        -
        public boolean isString()
        -
        Whether or not the object represents a string.
        -
        • -
      - - - -
        -
      • -

        make

        -
        public static DSElement make(boolean arg)
        -
        Creates an DSIObject representation of the primitive.
        -
        • -
      - - - -
        -
      • -

        make

        -
        public static DSElement make(byte[] arg)
        -
        Creates an DSIObject representation of the primitive.
        -
        • -
      - - - -
        -
      • -

        make

        -
        public static DSElement make(double arg)
        -
        Creates an DSIObject representation of the primitive.
        -
        • -
      - - - -
        -
      • -

        make

        -
        public static DSElement make(int arg)
        -
        Creates an DSIObject representation of the primitive.
        -
        • -
      - - - -
        -
      • -

        make

        -
        public static DSElement make(long arg)
        -
        Creates an DSIObject representation of the primitive.
        -
        • -
      - - - -
        -
      • -

        make

        -
        public static DSElement make(java.lang.String arg)
        -
        Creates an DSIObject representation of the primitive.
        -
        • -
      - - - -
        -
      • -

        makeNull

        -
        public static DSElement makeNull()
        -
        Creates an DSIObject representation of null.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        toBytes

        -
        public byte[] toBytes()
        -
        Returns the raw byte array for DSBytes only, which should not be modified.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not DSBytes.
        -
        -
        • -
      - - - -
        -
      • -

        toDouble

        -
        public double toDouble()
        -
        Attempts to return a double value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not convertible.
        -
        -
        • -
      - - - -
        -
      • -

        toElement

        -
        public DSElement toElement()
        -
        Returns this.
        -
        • -
      - - - -
        -
      • -

        toFloat

        -
        public float toFloat()
        -
        Attempts to return a float value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not convertible.
        -
        -
        • -
      - - - -
        -
      • -

        toGroup

        -
        public DSGroup toGroup()
        -
        Lists and maps return themselves, everything else results in an exception.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not convertible.
        -
        -
        • -
      - - - -
        -
      • -

        toInt

        -
        public int toInt()
        -
        Attempts to return an int value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not convertible.
        -
        -
        • -
      - - - -
        -
      • -

        toList

        -
        public DSList toList()
        -
        Lists return themselves, everything else results in an exception.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not convertible.
        -
        -
        • -
      - - - -
        -
      • -

        toLong

        -
        public long toLong()
        -
        Attempts to return a long value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not convertible.
        -
        -
        • -
      - - - -
        -
      • -

        toMap

        -
        public DSMap toMap()
        -
        Maps return themselves, everything else results in an exception.
        -
        -
        Throws:
        -
        java.lang.ClassCastException - If not convertible.
        -
        -
        • -
      - - - - -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSElementType.html b/docs/javadoc/org/iot/dsa/node/DSElementType.html deleted file mode 100644 index 33c31777..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSElementType.html +++ /dev/null @@ -1,429 +0,0 @@ - - - - - -DSElementType (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node
-

Enum DSElementType

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<DSElementType>
    -
    -
    -
    -
    public enum DSElementType
-extends java.lang.Enum<DSElementType>
    -
    The core set of elements that translate directly to a JSON type.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringtoString() 
      static DSElementTypevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static DSElementType[]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, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static DSElementType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DSElementType c : DSElementType.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Enum<DSElementType>
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSFlexEnum.html b/docs/javadoc/org/iot/dsa/node/DSFlexEnum.html deleted file mode 100644 index 03afa81a..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSFlexEnum.html +++ /dev/null @@ -1,604 +0,0 @@ - - - - - -DSFlexEnum (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSFlexEnum

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSFlexEnumNULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DSFlexEnumcopy() -
      Returns this.
      -
      booleanequals(java.lang.Object arg) -
      True if the argument is a DSFlexEnum and the values are equal or they are both isNull.
      -
      DSListgetEnums(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.
      -
      DSValueTypegetValueType() -
      The DSA type mapping.
      -
      inthashCode() 
      booleanisEqual(java.lang.Object obj) -
      Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
      -
      booleanisNull() -
      Values should have an instance representing null.
      -
      DSFlexEnumrestore(DSElement arg) -
      Deserialize a value from the configuration database, these will be values returned from the - store() method.
      -
      DSMapstore() -
      Serialize the value for the configuration database.
      -
      DSElementtoElement() -
      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()
      -
      DSFlexEnumvalueOf(DSElement arg) -
      This should convert an element transmitted over DSA, such as subscription updates or set - requests.
      -
      DSFlexEnumvalueOf(java.lang.String value) -
      Creates a new enum for the given value using the range from this instance.
      -
      static DSFlexEnumvalueOf(java.lang.String value, - 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
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        True if the argument is a DSFlexEnum and the values are equal or they are both isNull.
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        getEnums

        -
        public DSList getEnums(DSList bucket)
        -
        Description copied from interface: DSIEnum
        -
        Adds the range of possible values to the given bucket.
        -
        -
        Specified by:
        -
        getEnums in interface DSIEnum
        -
        Parameters:
        -
        bucket - Also the return value, can be null, which will result in the creation of a new - list.
        -
        Returns:
        -
        The list argument, or if it was null, a new list.
        -
        -
        • -
      - - - -
        -
      • -

        getMetadata

        -
        public void getMetadata(DSMap bucket)
        -
        Description copied from interface: DSIMetadata
        -
        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 in interface DSIMetadata
        -
        -
        • -
      - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public DSFlexEnum restore(DSElement arg)
        -
        Description copied from interface: DSIStorable
        -
        Deserialize a value from the configuration database, these will be values returned from the - store() method.
        -
        -
        Specified by:
        -
        restore in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        store

        -
        public DSMap store()
        -
        Description copied from interface: DSIStorable
        -
        Serialize the value for the configuration database. Can be a different element type than - toElement().
        -
        -
        Specified by:
        -
        store in interface 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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Specified by:
        -
        toString in interface DSIEnum
        -
        Overrides:
        -
        toString in class 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 in interface 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.
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public DSFlexEnum valueOf(java.lang.String value)
        -
        Creates a new enum for the given value using the range from this instance.
        -
        -
        Parameters:
        -
        value - Must be a member of the range in this enum.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSFloat.html b/docs/javadoc/org/iot/dsa/node/DSFloat.html deleted file mode 100644 index f6c16ad8..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSFloat.html +++ /dev/null @@ -1,670 +0,0 @@ - - - - - -DSFloat (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSFloat

-
-
- -
-
    -
  • -
    -
    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 TypeField and Description
      static DSFloatNULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object arg) -
      True if the argument is a DSINumber and the values are equal or they are both isNull.
      -
      DSValueTypegetValueType() -
      The DSA type mapping.
      -
      inthashCode() 
      booleanisDouble() -
      Whether or not the object represents a double.
      -
      booleanisEqual(java.lang.Object obj) -
      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.
      -
      DSElementtoElement() -
      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()
      -
      DSFloatvalueOf(DSElement arg) -
      This should convert an element transmitted over DSA, such as subscription updates or set - requests.
      -
      static DSFloatvalueOf(float arg) -
      Attempts to reuse some common values before creating a new instance.
      -
      static DSFloatvalueOf(java.lang.String arg) -
      Checks for null, then uses Float.parseFloat()
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NULL

        -
        public static final DSFloat NULL
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        True if the argument is a DSINumber and the values are equal or they are both isNull.
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isDouble

        -
        public boolean isDouble()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents a double.
        -
        -
        Specified by:
        -
        isDouble in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isFloat

        -
        public boolean isFloat()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents a double.
        -
        -
        Specified by:
        -
        isFloat in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isInt

        -
        public boolean isInt()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents an int.
        -
        -
        Specified by:
        -
        isInt in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isLong

        -
        public boolean isLong()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents a long.
        -
        -
        Specified by:
        -
        isLong in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toDouble

        -
        public double toDouble()
        -
        Description copied from interface: DSINumber
        -
        If not a double, will cast the underlying value.
        -
        -
        Specified by:
        -
        toDouble in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toFloat

        -
        public float toFloat()
        -
        Description copied from interface: DSINumber
        -
        If not a float, will cast the underlying value.
        -
        -
        Specified by:
        -
        toFloat in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toInt

        -
        public int toInt()
        -
        Description copied from interface: DSINumber
        -
        If not an int, will cast the underlying value.
        -
        -
        Specified by:
        -
        toInt in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toLong

        -
        public long toLong()
        -
        Description copied from interface: DSINumber
        -
        If not a long, will cast the underlying value.
        -
        -
        Specified by:
        -
        toLong in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toNumber

        -
        public java.lang.Number toNumber()
        -
        Description copied from interface: DSINumber
        -
        Returns the Java primitive wrapper.
        -
        -
        Specified by:
        -
        toNumber in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class 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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSFloat valueOf(float arg)
        -
        Attempts to reuse some common values before creating a new instance.
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSFloat valueOf(java.lang.String arg)
        -
        Checks for null, then uses Float.parseFloat()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSGroup.html b/docs/javadoc/org/iot/dsa/node/DSGroup.html deleted file mode 100644 index e5a04e9d..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSGroup.html +++ /dev/null @@ -1,834 +0,0 @@ - - - - - -DSGroup (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSGroup

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject, DSIValue
    -
    -
    -
    Direct Known Subclasses:
    -
    DSList, DSMap
    -
    -
    -
    -
    public abstract class DSGroup
-extends DSElement
    -
    An index accessible collection of primitives.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSGroup

        -
        public DSGroup()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        clear

        -
        public abstract DSGroup clear()
        -
        Removes all items.
        -
        -
        Returns:
        -
        This
        -
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object o)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        hasParent

        -
        public boolean hasParent()
        -
        • -
      - - - -
        -
      • -

        first

        -
        public DSElement first()
        -
        Returns the item at index 0.
        -
        -
        Returns:
        -
        Null if empty.
        -
        -
        • -
      - - - -
        -
      • -

        get

        -
        public abstract DSElement get(int idx)
        -
        Returns the value at the given index.
        -
        • -
      - - - -
        -
      • -

        get

        -
        public boolean get(int idx,
-                   boolean def)
        -
        Optional getter.
        -
        • -
      - - - -
        -
      • -

        get

        -
        public double get(int idx,
-                  double def)
        -
        Optional getter.
        -
        • -
      - - - -
        -
      • -

        get

        -
        public int get(int idx,
-               int def)
        -
        Optional getter.
        -
        • -
      - - - -
        -
      • -

        get

        -
        public long get(int idx,
-                long def)
        -
        Optional getter.
        -
        • -
      - - - -
        -
      • -

        get

        -
        public java.lang.String get(int idx,
-                            java.lang.String def)
        -
        Optional getter.
        -
        • -
      - - - -
        -
      • -

        getBoolean

        -
        public boolean getBoolean(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getDouble

        -
        public double getDouble(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getFloat

        -
        public double getFloat(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getInt

        -
        public int getInt(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getList

        -
        public DSList getList(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getLong

        -
        public long getLong(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getMap

        -
        public DSMap getMap(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString(int idx)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        indexOf

        -
        public int indexOf(DSElement obj)
        -
        Scans the collection and returns the first index that equal the arg.
        -
        -
        Returns:
        -
        -1 if not found.
        -
        -
        • -
      - - - -
        -
      • -

        isEmpty

        -
        public boolean isEmpty()
        -
        Returns true when childCount() == 0.
        -
        • -
      - - - -
        -
      • -

        isGroup

        -
        public boolean isGroup()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a list or map.
        -
        -
        Overrides:
        -
        isGroup in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull(int idx)
        -
        Whether or not the object at the given index is null. Will return true if the index is out - of bounds.
        -
        • -
      - - - -
        -
      • -

        last

        -
        public DSElement last()
        -
        Returns the item at the highest index.
        -
        -
        Returns:
        -
        Null if empty.
        -
        -
        • -
      - - - -
        -
      • -

        lastIndexOf

        -
        public int lastIndexOf(DSElement obj)
        -
        Scans the collection and returns the first index that equal the arg.
        -
        -
        Returns:
        -
        -1 if not found.
        -
        -
        • -
      - - - -
        -
      • -

        remove

        -
        public abstract DSElement remove(int idx)
        -
        Removes the value at the given index and returns it.
        -
        -
        Returns:
        -
        The value removed.
        -
        -
        • -
      - - - -
        -
      • -

        removeFirst

        -
        public DSElement removeFirst()
        -
        Remove and return the item at index 0.
        -
        -
        Returns:
        -
        The value removed.
        -
        -
        • -
      - - - -
        -
      • -

        removeLast

        -
        public DSElement removeLast()
        -
        Remove and return the item at the highest index.
        -
        -
        Returns:
        -
        The value removed.
        -
        -
        • -
      - - - -
        -
      • -

        toGroup

        -
        public DSGroup toGroup()
        -
        Description copied from class: DSElement
        -
        Lists and maps return themselves, everything else results in an exception.
        -
        -
        Overrides:
        -
        toGroup in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        size

        -
        public abstract int size()
        -
        The number of items is the group.
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Json encodes the graph, be careful.
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSIBoolean.html b/docs/javadoc/org/iot/dsa/node/DSIBoolean.html deleted file mode 100644 index 4b69a769..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSIBoolean.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - -DSIBoolean (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSIBoolean

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    DSBool
    -
    -
    -
    -
    public interface DSIBoolean
    -
    Indicates something that is/has a boolean value.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        toBoolean

        -
        boolean toBoolean()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSIEnum.html b/docs/javadoc/org/iot/dsa/node/DSIEnum.html deleted file mode 100644 index 19c13492..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSIEnum.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - -DSIEnum (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSIEnum

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    DSFlexEnum, DSJavaEnum
    -
    -
    -
    -
    public interface DSIEnum
    -
    DSA Enum mapping.
    -
    • -
-
-
-
    -
  • - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getEnums

        -
        DSList getEnums(DSList bucket)
        -
        Adds the range of possible values to the given bucket.
        -
        -
        Parameters:
        -
        bucket - Also the return value, can be null, which will result in the creation of a new - list.
        -
        Returns:
        -
        The list argument, or if it was null, a new list.
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        java.lang.String toString()
        -
        The string representation of the the enum value.
        -
        -
        Overrides:
        -
        toString in class java.lang.Object
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSIMetadata.html b/docs/javadoc/org/iot/dsa/node/DSIMetadata.html deleted file mode 100644 index 0e96dced..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSIMetadata.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - -DSIMetadata (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSIMetadata

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    DSFlexEnum, DSJavaEnum
    -
    -
    -
    -
    public interface DSIMetadata
    -
    Nodes and values can implement this to provide meta-data about themselves.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      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).
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSINumber.html b/docs/javadoc/org/iot/dsa/node/DSINumber.html deleted file mode 100644 index 6797843f..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSINumber.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - -DSINumber (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSINumber

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    DSDouble, DSFloat, DSInt, DSLong
    -
    -
    -
    -
    public interface DSINumber
    -
    Indicates something that is/has a numeric value.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod 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.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isDouble

        -
        boolean isDouble()
        -
        Whether or not the object represents a double.
        -
        • -
      - - - -
        -
      • -

        isFloat

        -
        boolean isFloat()
        -
        Whether or not the object represents a double.
        -
        • -
      - - - -
        -
      • -

        isInt

        -
        boolean isInt()
        -
        Whether or not the object represents an int.
        -
        • -
      - - - -
        -
      • -

        isLong

        -
        boolean isLong()
        -
        Whether or not the object represents a long.
        -
        • -
      - - - -
        -
      • -

        toDouble

        -
        double toDouble()
        -
        If not a double, will cast the underlying value.
        -
        • -
      - - - -
        -
      • -

        toFloat

        -
        float toFloat()
        -
        If not a float, will cast the underlying value.
        -
        • -
      - - - -
        -
      • -

        toInt

        -
        int toInt()
        -
        If not an int, will cast the underlying value.
        -
        • -
      - - - -
        -
      • -

        toLong

        -
        long toLong()
        -
        If not a long, will cast the underlying value.
        -
        • -
      - - - -
        -
      • -

        toNumber

        -
        java.lang.Number toNumber()
        -
        Returns the Java primitive wrapper.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSIObject.html b/docs/javadoc/org/iot/dsa/node/DSIObject.html deleted file mode 100644 index 04e0da8c..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSIObject.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - - -DSIObject (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSIObject

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      DSIObjectcopy() -
      Return a copy if it makes sense, but return this otherwise.
      -
      booleanisEqual(java.lang.Object obj) -
      Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
      -
      booleanisNull() 
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        copy

        -
        DSIObject copy()
        -
        Return a copy if it makes sense, but return this otherwise.
        -
        • -
      - - - -
        -
      • -

        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()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSIStatus.html b/docs/javadoc/org/iot/dsa/node/DSIStatus.html deleted file mode 100644 index babd55db..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSIStatus.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - -DSIStatus (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSIStatus

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    DSStatus
    -
    -
    -
    -
    public interface DSIStatus
    -
    Indicates something that is/has a quality.
    -
    • -
-
-
- -
-
-
    -
  • - - -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSIStorable.html b/docs/javadoc/org/iot/dsa/node/DSIStorable.html deleted file mode 100644 index a6532d00..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSIStorable.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - -DSIStorable (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSIStorable

-
-
-
- -
-
-
    -
  • - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        restore

        -
        DSIValue restore(DSElement element)
        -
        Deserialize a value from the configuration database, these will be values returned from the - store() method.
        -
        • -
      - - - -
        -
      • -

        store

        -
        DSElement store()
        -
        Serialize the value for the configuration database. Can be a different element type than - toElement().
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSIValue.html b/docs/javadoc/org/iot/dsa/node/DSIValue.html deleted file mode 100644 index 7c26f724..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSIValue.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - -DSIValue (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Interface DSIValue

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    DSIObject
    -
    -
    -
    All Known Subinterfaces:
    -
    DSIPassword
    -
    -
    -
    All Known Implementing Classes:
    -
    DSBool, DSBytes, DSDateTime, DSDouble, DSElement, DSFlexEnum, DSFloat, DSGroup, DSInt, DSJavaEnum, DSList, DSLong, DSMap, DSNull, DSPasswordAes, DSPasswordSha256, DSStatus, DSString, DSValue, DSValueNode
    -
    -
    -
    -
    public interface DSIValue
-extends DSIObject
    -
    How data values are represented in the node tree. - -

    - - Beyond the interface methods, custom implementations should: - -

    - -

      - -
    • Have a NULL instance if possible. - -
    • Try to maintain singleton instances when possible, especially for common instances. - -
    • Instead of constructors, use static valueOf methods to ensure singleton values such as NULL - are used. - -
    • Register an instance for decoding with DSRegistry.registerDecoder(YourValue.class, instance) - in a static initializer. If you have a NULL instance, use that. - -
    • If mutable (avoid if at all possible), implement DSIPublisher so nodes know of changes. - -
    • If a DSNode subclass is implementing DSIValue, it's onSet(DSIValue) must also be overridden. - -
    -
    -
    See Also:
    -
    DSNode.onSet(DSIValue)
    -
    -
    • -
-
-
-
    -
  • - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getValueType

        -
        DSValueType getValueType()
        -
        The DSA type mapping.
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        boolean isNull()
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        toElement

        -
        DSElement toElement()
        -
        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

        -
        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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSInfo.html b/docs/javadoc/org/iot/dsa/node/DSInfo.html deleted file mode 100644 index 27d92142..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSInfo.html +++ /dev/null @@ -1,921 +0,0 @@ - - - - - -DSInfo (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Class DSInfo

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ApiObject
    -
    -
    -
    -
    public class DSInfo
-extends java.lang.Object
-implements ApiObject
    -
    All node children have corresponding DSInfo instances. This type serves two purposes: - -

    - -

      - -
    • It carries some meta-data about the relationship between the parent node and the child. - -
    • 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 default infos to avoid looking up the child - every time it is needed. This is can be used to create fast getters and setters. - -
    - -

    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DSInfocopy() 
      voiddecodeState(DSElement state) 
      DSElementencodeState() 
      booleanequals(java.lang.Object arg) 
      booleanequalsDefault() -
      True if this proxies a default and the state and value match the default.
      -
      booleanequalsDefaultState() -
      True if the state matches the default state.
      -
      booleanequalsDefaultType() -
      True if this proxies a default and the value type matches the default.
      -
      booleanequalsDefaultValue() -
      True if this proxies a default and the value matches the default.
      -
      DSActiongetAction() -
      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.
      -
      DSIObjectgetDefaultObject() -
      If this represents a dynamic child, this just returns the current value.
      -
      DSElementgetElement() -
      A convenience that casts getObject().
      -
      voidgetMetadata(DSMap bucket) 
      java.lang.StringgetName() -
      The display name.
      -
      DSNodegetNode() -
      A convenience that casts getObject().
      -
      DSIObjectgetObject() 
      DSNodegetParent() 
      DSIValuegetValue() -
      A convenience that casts getObject().
      -
      booleanhasChildren() -
      True if getChildren() can be called.
      -
      inthashCode() 
      booleanhasNext() -
      True if there is another info after this one.
      -
      booleanisAction() -
      True if the object is an action.
      -
      booleanisAdmin() -
      Whether or not this object requires configuration permission to read/write.
      -
      booleanisDefaultOnCopy() -
      Whether or not the current value, or the default value is copied.
      -
      booleanisDynamic() -
      Whether or not this info represents a declared default.
      -
      booleanisEqual(DSInfo arg) -
      True if the flags and target object are equal (not identical if the target is a node).
      -
      booleanisHidden() -
      Whether or not an object is visible to clients.
      -
      booleanisIdentical(DSInfo arg) -
      True if the flags and target object are identical.
      -
      booleanisNode() -
      Whether or not the object is a DSNode.
      -
      booleanisReadOnly() -
      Whether or not an object can be written by a client.
      -
      booleanisTransient() -
      Whether or not an object is persistent.
      -
      booleanisValue() -
      True if getValue() can be called.
      -
      DSInfonext() -
      The next info in the parent node.
      -
      DSInfonextAction() -
      The next DSInfo in the parent that is an action, or null.
      -
      DSInfonextNode() -
      The next DSInfo in the parent that is a node, or null.
      -
      DSInfonextValue() -
      The next DSInfo in the parent that is a value, or null.
      -
      DSInfosetAdmin(boolean admin) 
      DSInfosetHidden(boolean hidden) 
      DSInfosetReadOnly(boolean readOnly) 
      DSInfosetTransient(boolean trans) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        copy

        -
        public DSInfo copy()
        -
        • -
      - - - -
        -
      • -

        decodeState

        -
        public void decodeState(DSElement state)
        -
        • -
      - - - -
        -
      • -

        encodeState

        -
        public DSElement encodeState()
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        equalsDefault

        -
        public boolean equalsDefault()
        -
        True if this proxies a default and the state and value match the default.
        -
        • -
      - - - -
        -
      • -

        equalsDefaultState

        -
        public boolean equalsDefaultState()
        -
        True if the state matches the default state.
        -
        • -
      - - - -
        -
      • -

        equalsDefaultType

        -
        public boolean equalsDefaultType()
        -
        True if this proxies a default and the value type matches the default.
        -
        • -
      - - - -
        -
      • -

        equalsDefaultValue

        -
        public boolean equalsDefaultValue()
        -
        True if this proxies a default and the value matches the default.
        -
        • -
      - - - -
        -
      • -

        getAction

        -
        public DSAction getAction()
        -
        Description copied from interface: ApiObject
        -
        The action, should only be called if isAction() returns true.
        -
        -
        Specified by:
        -
        getAction in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        getChildren

        -
        public java.util.Iterator<ApiObject> getChildren()
        -
        Description copied from interface: ApiObject
        -
        Iterator of child objects, should only be called if hasChildren() returns true.
        -
        -
        Specified by:
        -
        getChildren in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        getDefaultObject

        -
        public DSIObject getDefaultObject()
        -
        If this represents a dynamic child, this just returns the current value.
        -
        • -
      - - - -
        -
      • -

        getElement

        -
        public DSElement getElement()
        -
        A convenience that casts getObject().
        -
        • -
      - - - -
        -
      • -

        getName

        -
        public java.lang.String getName()
        -
        Description copied from interface: ApiObject
        -
        The display name.
        -
        -
        Specified by:
        -
        getName in interface ApiObject
        -
        -
        • -
      - - - - - - - -
        -
      • -

        getNode

        -
        public DSNode getNode()
        -
        A convenience that casts getObject().
        -
        • -
      - - - -
        -
      • -

        getObject

        -
        public DSIObject getObject()
        -
        • -
      - - - -
        -
      • -

        getParent

        -
        public DSNode getParent()
        -
        • -
      - - - -
        -
      • -

        getValue

        -
        public DSIValue getValue()
        -
        A convenience that casts getObject().
        -
        -
        Specified by:
        -
        getValue in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        hasChildren

        -
        public boolean hasChildren()
        -
        Description copied from interface: ApiObject
        -
        True if getChildren() can be called.
        -
        -
        Specified by:
        -
        hasChildren in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        hasNext

        -
        public boolean hasNext()
        -
        True if there is another info after this one.
        -
        • -
      - - - -
        -
      • -

        isAction

        -
        public boolean isAction()
        -
        Description copied from interface: ApiObject
        -
        True if the object is an action.
        -
        -
        Specified by:
        -
        isAction in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        isAdmin

        -
        public boolean isAdmin()
        -
        Description copied from interface: ApiObject
        -
        Whether or not this object requires configuration permission to read/write.
        -
        -
        Specified by:
        -
        isAdmin in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        isDefaultOnCopy

        -
        public boolean isDefaultOnCopy()
        -
        Whether or not the current value, or the default value is copied.
        -
        • -
      - - - -
        -
      • -

        isDynamic

        -
        public boolean isDynamic()
        -
        Whether or not this info represents a declared default.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        isHidden

        -
        public boolean isHidden()
        -
        Whether or not an object is visible to clients.
        -
        -
        Specified by:
        -
        isHidden in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        isIdentical

        -
        public boolean isIdentical(DSInfo arg)
        -
        True if the flags and target object are identical. Two nodes are identical if their children - are in the same order.
        -
        • -
      - - - -
        -
      • -

        isNode

        -
        public boolean isNode()
        -
        Whether or not the object is a DSNode.
        -
        • -
      - - - -
        -
      • -

        isReadOnly

        -
        public boolean isReadOnly()
        -
        Whether or not an object can be written by a client.
        -
        -
        Specified by:
        -
        isReadOnly in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        isTransient

        -
        public boolean isTransient()
        -
        Whether or not an object is persistent.
        -
        • -
      - - - -
        -
      • -

        isValue

        -
        public boolean isValue()
        -
        Description copied from interface: ApiObject
        -
        True if getValue() can be called.
        -
        -
        Specified by:
        -
        isValue in interface ApiObject
        -
        -
        • -
      - - - -
        -
      • -

        next

        -
        public DSInfo next()
        -
        The next info in the parent node.
        -
        • -
      - - - -
        -
      • -

        nextAction

        -
        public DSInfo nextAction()
        -
        The next DSInfo in the parent that is an action, or null.
        -
        • -
      - - - -
        -
      • -

        nextNode

        -
        public DSInfo nextNode()
        -
        The next DSInfo in the parent that is a node, or null.
        -
        • -
      - - - -
        -
      • -

        nextValue

        -
        public DSInfo nextValue()
        -
        The next DSInfo in the parent that is a value, or null.
        -
        • -
      - - - -
        -
      • -

        setAdmin

        -
        public DSInfo setAdmin(boolean admin)
        -
        • -
      - - - -
        -
      • -

        setHidden

        -
        public DSInfo setHidden(boolean hidden)
        -
        • -
      - - - -
        -
      • -

        setReadOnly

        -
        public DSInfo setReadOnly(boolean readOnly)
        -
        • -
      - - - -
        -
      • -

        setTransient

        -
        public DSInfo setTransient(boolean trans)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSInt.html b/docs/javadoc/org/iot/dsa/node/DSInt.html deleted file mode 100644 index fc839f8b..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSInt.html +++ /dev/null @@ -1,669 +0,0 @@ - - - - - -DSInt (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSInt

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSIntNULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object arg) -
      True if the argument is a DSINumber and the values are equal or they are both isNull.
      -
      DSValueTypegetValueType() -
      The DSA type mapping.
      -
      inthashCode() 
      booleanisDouble() -
      Whether or not the object represents a double.
      -
      booleanisEqual(java.lang.Object obj) -
      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.
      -
      DSElementtoElement() -
      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()
      -
      DSIntvalueOf(DSElement arg) -
      This should convert an element transmitted over DSA, such as subscription updates or set - requests.
      -
      static DSIntvalueOf(int arg) -
      Attempts to reuse some common values before creating a new instance.
      -
      static DSIntvalueOf(java.lang.String arg) -
      Checks for null, then uses Float.parseFloat()
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NULL

        -
        public static final DSInt NULL
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        True if the argument is a DSINumber and the values are equal or they are both isNull.
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isDouble

        -
        public boolean isDouble()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents a double.
        -
        -
        Specified by:
        -
        isDouble in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isFloat

        -
        public boolean isFloat()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents a double.
        -
        -
        Specified by:
        -
        isFloat in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isInt

        -
        public boolean isInt()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents an int.
        -
        -
        Specified by:
        -
        isInt in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isLong

        -
        public boolean isLong()
        -
        Description copied from interface: DSINumber
        -
        Whether or not the object represents a long.
        -
        -
        Specified by:
        -
        isLong in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toDouble

        -
        public double toDouble()
        -
        Description copied from interface: DSINumber
        -
        If not a double, will cast the underlying value.
        -
        -
        Specified by:
        -
        toDouble in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toFloat

        -
        public float toFloat()
        -
        Description copied from interface: DSINumber
        -
        If not a float, will cast the underlying value.
        -
        -
        Specified by:
        -
        toFloat in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toInt

        -
        public int toInt()
        -
        Description copied from interface: DSINumber
        -
        If not an int, will cast the underlying value.
        -
        -
        Specified by:
        -
        toInt in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toLong

        -
        public long toLong()
        -
        Description copied from interface: DSINumber
        -
        If not a long, will cast the underlying value.
        -
        -
        Specified by:
        -
        toLong in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toNumber

        -
        public java.lang.Number toNumber()
        -
        Description copied from interface: DSINumber
        -
        Returns the Java primitive wrapper.
        -
        -
        Specified by:
        -
        toNumber in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class 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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSInt valueOf(int arg)
        -
        Attempts to reuse some common values before creating a new instance.
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSInt valueOf(java.lang.String arg)
        -
        Checks for null, then uses Float.parseFloat()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSJavaEnum.html b/docs/javadoc/org/iot/dsa/node/DSJavaEnum.html deleted file mode 100644 index b8843338..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSJavaEnum.html +++ /dev/null @@ -1,589 +0,0 @@ - - - - - -DSJavaEnum (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSJavaEnum

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSJavaEnumNULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object arg) -
      True if the argument is a DSDynamicEnum and the values are equal or they are both isNull.
      -
      DSListgetEnums(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.
      -
      DSValueTypegetValueType() -
      The DSA type mapping.
      -
      inthashCode() 
      booleanisEqual(java.lang.Object obj) -
      Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
      -
      booleanisNull() -
      Values should have an instance representing null.
      -
      DSJavaEnumrestore(DSElement arg) -
      Deserialize a value from the configuration database, these will be values returned from the - store() method.
      -
      DSElementstore() -
      Serialize the value for the configuration database.
      -
      DSElementtoElement() -
      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()
      -
      DSJavaEnumvalueOf(DSElement arg) -
      This should convert an element transmitted over DSA, such as subscription updates or set - requests.
      -
      static DSJavaEnumvalueOf(java.lang.Enum value) -
      Creates an enum for the given value (and it's range).
      -
      DSJavaEnumvalueOf(java.lang.String arg) 
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        True if the argument is a DSDynamicEnum and the values are equal or they are both isNull.
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        getEnums

        -
        public DSList getEnums(DSList bucket)
        -
        Description copied from interface: DSIEnum
        -
        Adds the range of possible values to the given bucket.
        -
        -
        Specified by:
        -
        getEnums in interface DSIEnum
        -
        Parameters:
        -
        bucket - Also the return value, can be null, which will result in the creation of a new - list.
        -
        Returns:
        -
        The list argument, or if it was null, a new list.
        -
        -
        • -
      - - - -
        -
      • -

        getMetadata

        -
        public void getMetadata(DSMap bucket)
        -
        Description copied from interface: DSIMetadata
        -
        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 in interface DSIMetadata
        -
        -
        • -
      - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public DSJavaEnum restore(DSElement arg)
        -
        Description copied from interface: DSIStorable
        -
        Deserialize a value from the configuration database, these will be values returned from the - store() method.
        -
        -
        Specified by:
        -
        restore in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        store

        -
        public DSElement store()
        -
        Description copied from interface: DSIStorable
        -
        Serialize the value for the configuration database. Can be a different element type than - toElement().
        -
        -
        Specified by:
        -
        store in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        toEnum

        -
        public java.lang.Enum toEnum()
        -
        The Java enum.
        -
        • -
      - - - -
        -
      • -

        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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Specified by:
        -
        toString in interface DSIEnum
        -
        Overrides:
        -
        toString in class 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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSJavaEnum valueOf(java.lang.Enum value)
        -
        Creates an enum for the given value (and it's range).
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public DSJavaEnum valueOf(java.lang.String arg)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSList.html b/docs/javadoc/org/iot/dsa/node/DSList.html deleted file mode 100644 index 9f04f5c6..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSList.html +++ /dev/null @@ -1,975 +0,0 @@ - - - - - -DSList (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node
-

Class DSList

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.Iterable<DSElement>, DSIObject, DSIValue
    -
    -
    -
    -
    public class DSList
-extends DSGroup
-implements java.lang.Iterable<DSElement>
    -
    Indexed collection of elements. - -

    - - This can be mounted in the node tree. However, the parent node will not know when it has been - modified, so the modifier is responsible for calling DSNode.childChanged(DSInfo). - -

    - - This is not thread safe.

    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        list

        -
        protected java.util.ArrayList list
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSList

        -
        public DSList()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        add

        -
        public DSList add(DSElement val)
        -
        Adds the value and returns this.
        -
        -
        Parameters:
        -
        val - Can be null, and can not be an already parented group.
        -
        Returns:
        -
        this
        -
        -
        • -
      - - - -
        -
      • -

        add

        -
        public DSList add(boolean val)
        -
        Appends the primitive and returns this.
        -
        • -
      - - - -
        -
      • -

        add

        -
        public DSList add(double val)
        -
        Appends the primitive and returns this.
        -
        • -
      - - - -
        -
      • -

        add

        -
        public DSList add(long val)
        -
        Appends the primitive and returns this.
        -
        • -
      - - - -
        -
      • -

        add

        -
        public DSList add(java.lang.String val)
        -
        Appends the primitive and returns this.
        -
        • -
      - - - -
        -
      • -

        add

        -
        public DSList add(int val)
        -
        Appends the primitive and returns this.
        -
        • -
      - - - -
        -
      • -

        addAll

        -
        public DSList addAll(DSList list)
        -
        Add all elements of the argument to this list and returns this.
        -
        • -
      - - - -
        -
      • -

        addList

        -
        public DSList addList()
        -
        Appends a new list and returns it. This is going to cause trouble, but the the primary usage - won't be to add an empty list.
        -
        • -
      - - - -
        -
      • -

        addMap

        -
        public DSMap addMap()
        -
        Appends a new map and returns it.
        -
        • -
      - - - -
        -
      • -

        addNull

        -
        public DSList addNull()
        -
        Appends null and returns this.
        -
        • -
      - - - -
        -
      • -

        clear

        -
        public DSList clear()
        -
        Description copied from class: DSGroup
        -
        Removes all items.
        -
        -
        Specified by:
        -
        clear in class DSGroup
        -
        Returns:
        -
        This
        -
        -
        • -
      - - - -
        -
      • -

        contains

        -
        public boolean contains(DSElement value)
        -
        • -
      - - - -
        -
      • -

        copy

        -
        public DSList copy()
        -
        Description copied from class: DSElement
        -
        If an object is mutable (list or map) then this should clone it, immutable objects can simply - return themselves.
        -
        -
        Specified by:
        -
        copy in interface DSIObject
        -
        Overrides:
        -
        copy in class DSElement
        -
        -
        • -
      - - - - - - - -
        -
      • -

        get

        -
        public DSElement get(int idx)
        -
        Description copied from class: DSGroup
        -
        Returns the value at the given index.
        -
        -
        Specified by:
        -
        get in class DSGroup
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        isList

        -
        public boolean isList()
        -
        Returns true.
        -
        -
        Overrides:
        -
        isList in class DSElement
        -
        -
        • -
      - - - - - - - -
        -
      • -

        iterator

        -
        public java.util.Iterator<DSElement> iterator()
        -
        Returns an iterator that does not implement remove.
        -
        -
        Specified by:
        -
        iterator in interface java.lang.Iterable<DSElement>
        -
        -
        • -
      - - - -
        -
      • -

        put

        -
        public DSList put(int idx,
-                  DSElement val)
        -
        Replaces a value and returns this.
        -
        -
        Parameters:
        -
        val - Can be null.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        remove

        -
        public DSElement remove(int idx)
        -
        Description copied from class: DSGroup
        -
        Removes the value at the given index and returns it.
        -
        -
        Specified by:
        -
        remove in class DSGroup
        -
        Returns:
        -
        The value removed.
        -
        -
        • -
      - - - -
        -
      • -

        size

        -
        public int size()
        -
        Description copied from class: DSGroup
        -
        The number of items is the group.
        -
        -
        Specified by:
        -
        size in class DSGroup
        -
        -
        • -
      - - - -
        -
      • -

        toList

        -
        public DSList toList()
        -
        Description copied from class: DSElement
        -
        Lists return themselves, everything else results in an exception.
        -
        -
        Overrides:
        -
        toList in class DSElement
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        valueOf

        -
        public static DSList valueOf(java.lang.Double... values)
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSList valueOf(java.lang.Long... values)
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSList valueOf(java.lang.String... values)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSLong.html b/docs/javadoc/org/iot/dsa/node/DSLong.html deleted file mode 100644 index ee79e8fc..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSLong.html +++ /dev/null @@ -1,661 +0,0 @@ - - - - - -DSLong (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSLong

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NULL

        -
        public static final DSLong NULL
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        True if the argument is a DSINumber and the values are equal or they are both isNull.
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isLong

        -
        public boolean isLong()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a long.
        -
        -
        Specified by:
        -
        isLong in interface DSINumber
        -
        Overrides:
        -
        isLong in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents null.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        Overrides:
        -
        isNull in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        isNumber

        -
        public boolean isNumber()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a number.
        -
        -
        Overrides:
        -
        isNumber in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toBoolean

        -
        public boolean toBoolean()
        -
        Description copied from class: DSElement
        -
        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 in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toDouble

        -
        public double toDouble()
        -
        Description copied from class: DSElement
        -
        Attempts to return a double value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toDouble in interface DSINumber
        -
        Overrides:
        -
        toDouble in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toFloat

        -
        public float toFloat()
        -
        Description copied from class: DSElement
        -
        Attempts to return a float value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toFloat in interface DSINumber
        -
        Overrides:
        -
        toFloat in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toInt

        -
        public int toInt()
        -
        Description copied from class: DSElement
        -
        Attempts to return an int value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toInt in interface DSINumber
        -
        Overrides:
        -
        toInt in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toLong

        -
        public long toLong()
        -
        Description copied from class: DSElement
        -
        Attempts to return a long value. Numerics of other types will cast the results. Booleans - will return 0 for false and 1 for true. Strings will attempt to parseRequest the numeric - which may result in a parseRequest exception. Anything else will throw a - ClassCastException.
        -
        -
        Specified by:
        -
        toLong in interface DSINumber
        -
        Overrides:
        -
        toLong in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toNumber

        -
        public java.lang.Number toNumber()
        -
        Description copied from interface: DSINumber
        -
        Returns the Java primitive wrapper.
        -
        -
        Specified by:
        -
        toNumber in interface DSINumber
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      - - - - - - - -
        -
      • -

        valueOf

        -
        public static DSLong valueOf(long arg)
        -
        Attempts to reuse some common values before creating a new instance.
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSLong valueOf(java.lang.String arg)
        -
        Checks for null, then uses Float.parseFloat()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSMap.Entry.html b/docs/javadoc/org/iot/dsa/node/DSMap.Entry.html deleted file mode 100644 index 1a936a07..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSMap.Entry.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - -DSMap.Entry (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node
-

Class 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

      - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      java.lang.StringgetKey() 
      DSElementgetValue() 
      inthashCode() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object obj)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        getKey

        -
        public java.lang.String getKey()
        -
        • -
      - - - -
        -
      • -

        getValue

        -
        public DSElement getValue()
        -
        • -
      - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSMap.html b/docs/javadoc/org/iot/dsa/node/DSMap.html deleted file mode 100644 index 9620bbf9..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSMap.html +++ /dev/null @@ -1,1224 +0,0 @@ - - - - - -DSMap (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node
-

Class DSMap

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject, DSIValue
    -
    -
    -
    -
    public class DSMap
-extends DSGroup
    -
    String keyed collection of elements that preserves the order of addition. Keys and values can be - accessed via index. - -

    - - This can be mounted in the node tree. However, the parent node will not know when it has been - modified, so the modifier is responsible for calling DSNode.childChanged(DSInfo). - -

    - - This is not thread safe.

    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass 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 TypeField 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 TypeMethod and Description
      DSMapclear() -
      Removes all items.
      -
      booleancontains(java.lang.String key) 
      DSMapcopy() -
      If an object is mutable (list or map) then this should clone it, immutable objects can simply - return themselves.
      -
      booleanequals(java.lang.Object arg) 
      DSElementget(int idx) -
      Returns the value at the given index.
      -
      DSElementget(java.lang.String key) -
      Returns the value for the given key.
      -
      booleanget(java.lang.String key, - boolean def) -
      Optional getter, returns the provided default if the value mapped to the key is null or not - convertible.
      -
      doubleget(java.lang.String key, - double def) -
      Optional getter, returns the provided default if the value mapped to the key is null.
      -
      intget(java.lang.String key, - int def) -
      Optional getter, returns the provided default if the value mapped to the key is null or not - convertible.
      -
      longget(java.lang.String key, - long def) -
      Optional getter, returns the provided default if the value mapped to the key is null or not - convertible.
      -
      java.lang.Stringget(java.lang.String key, - java.lang.String def) -
      Optional getter, returns the provided default if the value mapped to the key is null.
      -
      booleangetBoolean(java.lang.String key) -
      Primitive getter.
      -
      doublegetDouble(java.lang.String key) -
      Primitive getter.
      -
      DSElementTypegetElementType() -
      For switch statements.
      -
      DSMap.EntrygetEntry(int index) 
      DSMap.EntrygetEntry(java.lang.String key) 
      intgetInt(java.lang.String key) -
      Primitive getter.
      -
      java.lang.StringgetKey(int idx) -
      Returns the key at the given index.
      -
      DSListgetList(java.lang.String key) -
      Return the list, or null.
      -
      longgetLong(java.lang.String key) -
      Primitive getter.
      -
      DSMapgetMap(java.lang.String key) -
      Returns the map value for the given key, or null.
      -
      java.lang.StringgetString(java.lang.String key) -
      Returns the String value for the given key, or null.
      -
      DSValueTypegetValueType() -
      The DSA value type mapping.
      -
      inthashCode() 
      intindexOf(java.lang.String key) -
      Index of the given key, or -1.
      -
      booleanisMap() -
      Returns true.
      -
      booleanisNull() -
      Returns false.
      -
      booleanisNull(java.lang.String key) -
      Returns true if the key isn't in the map, or it's value is null.
      -
      DSMapput(java.lang.String key, - boolean val) -
      Primitive setter, returns this.
      -
      DSMapput(java.lang.String key, - double val) -
      Primitive setter, returns this.
      -
      DSMapput(java.lang.String key, - DSElement val) -
      Adds or replaces the value for the given key and returns this.
      -
      DSMapput(java.lang.String key, - int val) -
      Primitive setter, returns this.
      -
      DSMapput(java.lang.String key, - long val) -
      Primitive setter, returns this.
      -
      DSMapput(java.lang.String key, - java.lang.String val) -
      Primitive setter, returns this.
      -
      DSMapput(java.lang.String key, - java.lang.Throwable val) -
      Puts a String representing the stack trace into the map.
      -
      DSMapputAll(DSMap toAdd) -
      Adds / overwrites entries in this map with those from the given.
      -
      DSListputList(java.lang.String key) -
      Puts a new list for given key and returns it.
      -
      DSMapputMap(java.lang.String key) -
      Puts a new map for given key and returns it.
      -
      DSMapputNull(java.lang.String key) -
      Puts a null value for given key and returns this.
      -
      DSElementremove(int idx) -
      Removes the value at the given index and returns it.
      -
      DSElementremove(java.lang.String key) -
      Removes the key-value pair and returns the removed value.
      -
      intsize() -
      The number of items is the group.
      -
      DSMaptoElement() -
      Returns this.
      -
      DSMaptoMap() -
      Maps return themselves, everything else results in an exception.
      -
      DSMapvalueOf(DSElement element) -
      Returns the argument.
      -
      - - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        keys

        -
        protected java.util.List<DSMap.Entry> keys
        -
        For preserving order.
        -
        • -
      - - - -
        -
      • -

        map

        -
        protected java.util.Map<java.lang.String,DSMap.Entry> map
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSMap

        -
        public DSMap()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        clear

        -
        public DSMap clear()
        -
        Description copied from class: DSGroup
        -
        Removes all items.
        -
        -
        Specified by:
        -
        clear in class DSGroup
        -
        Returns:
        -
        This
        -
        -
        • -
      - - - -
        -
      • -

        contains

        -
        public boolean contains(java.lang.String key)
        -
        • -
      - - - -
        -
      • -

        copy

        -
        public DSMap copy()
        -
        Description copied from class: DSElement
        -
        If an object is mutable (list or map) then this should clone it, immutable objects can simply - return themselves.
        -
        -
        Specified by:
        -
        copy in interface DSIObject
        -
        Overrides:
        -
        copy in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object arg)
        -
        -
        Overrides:
        -
        equals in class DSGroup
        -
        -
        • -
      - - - -
        -
      • -

        get

        -
        public DSElement get(int idx)
        -
        Description copied from class: DSGroup
        -
        Returns the value at the given index.
        -
        -
        Specified by:
        -
        get in class DSGroup
        -
        -
        • -
      - - - -
        -
      • -

        get

        -
        public DSElement get(java.lang.String key)
        -
        Returns the value for the given key.
        -
        -
        Returns:
        -
        Possibly null.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        getBoolean

        -
        public boolean getBoolean(java.lang.String key)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getDouble

        -
        public double getDouble(java.lang.String key)
        -
        Primitive getter.
        -
        • -
      - - - - - - - -
        -
      • -

        getEntry

        -
        public DSMap.Entry getEntry(int index)
        -
        • -
      - - - -
        -
      • -

        getEntry

        -
        public DSMap.Entry getEntry(java.lang.String key)
        -
        • -
      - - - -
        -
      • -

        getList

        -
        public DSList getList(java.lang.String key)
        -
        Return the list, or null.
        -
        -
        Returns:
        -
        Possibly null.
        -
        -
        • -
      - - - -
        -
      • -

        getLong

        -
        public long getLong(java.lang.String key)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getInt

        -
        public int getInt(java.lang.String key)
        -
        Primitive getter.
        -
        • -
      - - - -
        -
      • -

        getKey

        -
        public java.lang.String getKey(int idx)
        -
        Returns the key at the given index.
        -
        • -
      - - - -
        -
      • -

        getMap

        -
        public DSMap getMap(java.lang.String key)
        -
        Returns the map value for the given key, or null.
        -
        -
        Returns:
        -
        Possibly 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 in class DSGroup
        -
        -
        • -
      - - - -
        -
      • -

        isMap

        -
        public boolean isMap()
        -
        Returns true.
        -
        -
        Overrides:
        -
        isMap in class 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.
        -
        • -
      - - - -
        -
      • -

        indexOf

        -
        public int indexOf(java.lang.String key)
        -
        Index of the given key, or -1.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        putAll

        -
        public DSMap putAll(DSMap toAdd)
        -
        Adds / overwrites entries in this map with those from the given.
        -
        -
        Returns:
        -
        This
        -
        -
        • -
      - - - -
        -
      • -

        putList

        -
        public DSList putList(java.lang.String key)
        -
        Puts a new list for given key and returns it.
        -
        • -
      - - - -
        -
      • -

        putMap

        -
        public DSMap putMap(java.lang.String key)
        -
        Puts a new map for given key and returns it.
        -
        • -
      - - - -
        -
      • -

        putNull

        -
        public DSMap putNull(java.lang.String key)
        -
        Puts a null value for given key and returns this.
        -
        • -
      - - - -
        -
      • -

        remove

        -
        public DSElement remove(int idx)
        -
        Description copied from class: DSGroup
        -
        Removes the value at the given index and returns it.
        -
        -
        Specified by:
        -
        remove in class DSGroup
        -
        Returns:
        -
        The value removed.
        -
        -
        • -
      - - - -
        -
      • -

        remove

        -
        public DSElement remove(java.lang.String key)
        -
        Removes the key-value pair and returns the removed value.
        -
        -
        Returns:
        -
        Possibly null.
        -
        -
        • -
      - - - -
        -
      • -

        size

        -
        public int size()
        -
        Description copied from class: DSGroup
        -
        The number of items is the group.
        -
        -
        Specified by:
        -
        size in class DSGroup
        -
        -
        • -
      - - - - - - - -
        -
      • -

        toMap

        -
        public DSMap toMap()
        -
        Description copied from class: DSElement
        -
        Maps return themselves, everything else results in an exception.
        -
        -
        Overrides:
        -
        toMap in class DSElement
        -
        -
        • -
      - - - - -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSMetadata.html b/docs/javadoc/org/iot/dsa/node/DSMetadata.html deleted file mode 100644 index 3d080306..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSMetadata.html +++ /dev/null @@ -1,1082 +0,0 @@ - - - - - -DSMetadata (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node
-

Class DSMetadata

-
-
- -
-
    -
  • -
    -
    -
    public class DSMetadata
-extends java.lang.Object
    -
    Utility fon constructing metadata maps.
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSMetadata

        -
        public DSMetadata()
        -
        • -
      - - - -
        -
      • -

        DSMetadata

        -
        public DSMetadata(DSMap map)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        clear

        -
        public DSMetadata clear(java.lang.String key)
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        getDecimalPlaces

        -
        public DSLong getDecimalPlaces()
        -
        The decimal precision or null.
        -
        • -
      - - - -
        -
      • -

        getDefault

        -
        public DSElement getDefault()
        -
        The default value for an action parameter, or null.
        -
        • -
      - - - -
        -
      • -

        getDescription

        -
        public java.lang.String getDescription()
        -
        The description, or null.
        -
        • -
      - - - -
        -
      • -

        getDisplayName

        -
        public java.lang.String getDisplayName()
        -
        The alternate display name, or null.
        -
        • -
      - - - -
        -
      • -

        getEditor

        -
        public java.lang.String getEditor()
        -
        The editor, or null.
        -
        • -
      - - - -
        -
      • -

        getEnumRange

        -
        public DSList getEnumRange()
        -
        The editor, or null.
        -
        • -
      - - - -
        -
      • -

        getMaxValue

        -
        public DSElement getMaxValue()
        -
        The max value, or null.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        getMinValue

        -
        public DSElement getMinValue()
        -
        The min value, or null.
        -
        • -
      - - - -
        -
      • -

        getName

        -
        public java.lang.String getName()
        -
        The name, or null.
        -
        • -
      - - - -
        -
      • -

        getPlaceHolder

        -
        public java.lang.String getPlaceHolder()
        -
        Placeholder text for text fields, or null.
        -
        • -
      - - - -
        -
      • -

        getType

        -
        public java.lang.String getType()
        -
        The type for action parameters, can be used to override types in the responder api.
        -
        • -
      - - - -
        -
      • -

        getUnit

        -
        public java.lang.String getUnit()
        -
        Value if defined, otherwise null.
        -
        • -
      - - - -
        -
      • -

        isEmpty

        -
        public boolean isEmpty()
        -
        • -
      - - - -
        -
      • -

        set

        -
        public DSMetadata set(java.lang.String key,
-                      DSElement value)
        -
        Set arbitrary keys.
        -
        • -
      - - - -
        -
      • -

        setBooleanRange

        -
        public DSMetadata setBooleanRange(DSList range)
        -
        The list must be size 2 and the entries must not be null.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - - - - - -
        -
      • -

        setDescription

        -
        public DSMetadata setDescription(java.lang.String arg)
        -
        • -
      - - - -
        -
      • -

        setDisplayName

        -
        public DSMetadata setDisplayName(java.lang.String arg)
        -
        • -
      - - - -
        -
      • -

        setEditor

        -
        public DSMetadata setEditor(java.lang.String arg)
        -
        See the EDITOR_ constants.
        -
        • -
      - - - -
        -
      • -

        setEnumRange

        -
        public DSMetadata setEnumRange(DSList arg)
        -
        List of string values for an enum or string.
        -
        • -
      - - - -
        -
      • -

        setEnumRange

        -
        public DSMetadata setEnumRange(java.lang.String... range)
        -
        List of string values for an enum or string.
        -
        • -
      - - - -
        -
      • -

        setMap

        -
        public DSMetadata setMap(DSMap arg)
        -
        Change the underlying map so the metadata instance can be reused.
        -
        • -
      - - - -
        -
      • -

        setMaxValue

        -
        public DSMetadata setMaxValue(DSElement arg)
        -
        The arg should be a number.
        -
        • -
      - - - -
        -
      • -

        setMinValue

        -
        public DSMetadata setMinValue(DSElement arg)
        -
        The arg should be a number.
        -
        • -
      - - - -
        -
      • -

        setName

        -
        public DSMetadata setName(java.lang.String arg)
        -
        • -
      - - - -
        -
      • -

        setPlaceHolder

        -
        public DSMetadata setPlaceHolder(java.lang.String arg)
        -
        Place holder text for text fields.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        setUnit

        -
        public DSMetadata setUnit(java.lang.String arg)
        -
        The unit identifier.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSNode.html b/docs/javadoc/org/iot/dsa/node/DSNode.html deleted file mode 100644 index 45a82be8..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSNode.html +++ /dev/null @@ -1,1916 +0,0 @@ - - - - - -DSNode (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node
-

Class DSNode

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.Iterable<DSInfo>, DSILevels, DSIObject
    -
    -
    -
    Direct Known Subclasses:
    -
    DSLink, DSLinkConnection, DSMainNode, DSSysNode, DSValueNode
    -
    -
    -
    -
    public class DSNode
-extends DSLogger
-implements DSIObject, java.lang.Iterable<DSInfo>
    -
    The organizational unit of the node tree. Most links will bind their specific logic by - subclassing DSNode and utilizing the lifecycle callbacks. -

    - To create a node subclass, you should understand the following concepts: -

    -

      -
    • Constructors -
    • Defaults -
    • Node Lifecycle and Callbacks -
    • Subscriptions -
    • Values -
    • Actions -
    • DSInfo -
    -

    -

    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 subtype of DSNode has a private default instance, all other instances of any particular - type are copies of the default instance. You should never perform application logic unless your - node is running (started or stable) because of this. -

    - If a DSNode subtype needs to have specific child nodes or values (most will), it should override - the declareDefaults method. The method should: -

    -

      -
    • Call super.declareDefaults(); -
    • 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. -
    -

    - During node serialization (configuration database, not DSA interop), children that match their - declared default are omitted. This has two benefits: -

    -

      -
    • Smaller node database means faster serialization / deserialization. -
    • Default values can be modified and all existing database will be automatically upgraded the - next time the updated class loaded. -
    -

    -

    Lifecycle

    -

    - It is important to know the node lifecycle. Your 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, 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. This is configurable as stableDelay in - slink.json. -

    - 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. -

    - Other Callbacks -

    - When a node is stable, there are several other callbacks for various state changes. All - callbacks begin with **on** such as onChildAdded(). -

    -

    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: -

    -

      -
    • DSElement - These map to the JSON type system and represent leaf members of the node tree. -
    • DSIValue - These don't map to the JSON type system, and it is possible for nodes to implement - this interface. This allows for values to have children. -
    -

    - Many values are singleton instances. This is for efficiency, the same value instance (e.g. - DSBoolean.TRUE) can be stored in many nodes. Singleton values must be immutable. -

    - 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

    -

    - Add actions to your node to allow requester invocation using org.iot.dsa.node.action.DSAction. -

    - Override DSNode.onInvoke to handle invocations. The reason for this is complicated but it is - possible to subclass DSAction, just carefully read the javadoc if you do. Be sure to call - super.onInvoke() when overriding that method. -

    -

    DSInfo

    -

    - All node children have corresponding DSInfo instances. This type serves two purposes: -

    -

      -
    • It carries some meta-data about the relationship between the parent node and the child. -
    • 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 default info instances to avoid looking up - the child every time it is needed. This is can be used to create fast getters and setters. -
    -

    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSNode() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DSInfoadd(java.lang.String name, - DSIObject object) -
      Adds the named child only if the name is not already in use.
      -
      intchildCount() -
      The number of children.
      -
      DSNodeclear() -
      Removes non-permanent children.
      -
      booleancontains(java.lang.String key) -
      Whether or not this node has a child with the given name.
      -
      DSNodecopy() -
      Returns a clone of this node and its subtree.
      -
      protected DSInfodeclareDefault(java.lang.String name, - 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.
      -
      DSIObjectget(java.lang.String name) -
      Returns the child value with the given name, or null.
      -
      DSElementgetElement(java.lang.String name) -
      A convenience for (DSElement) get(name).
      -
      DSIObjectgetFirst() -
      The first child, or null.
      -
      DSInfogetFirstInfo() -
      The first child info, or null.
      -
      DSInfogetFirstNodeInfo() -
      The info for the first child node, or null.
      -
      DSInfogetInfo() -
      DSInfo for this node in its parent, or null if un-parented.
      -
      DSInfogetInfo(java.lang.String name) -
      Returns the info for the child with the given name, or null.
      -
      DSIObjectgetLast() -
      The last child, or null.
      -
      DSInfogetLastInfo() -
      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.
      -
      DSNodegetNode(java.lang.String name) -
      A convenience for (DSNode) get(name).
      -
      DSNodegetParent() -
      Returns the parent node, or null.
      -
      java.lang.StringgetPath() -
      The DSA path, properly encoded.
      -
      DSIValuegetValue(java.lang.String name) -
      A convenience for (DSIValue) get(name).
      -
      protected booleanisDefaultInstance() -
      True if this is the default instance for the type.
      -
      booleanisEqual(java.lang.Object arg) -
      True if the argument is a node with the same children, although their order can be - different.
      -
      booleanisIdentical(java.lang.Object arg) -
      True if the argument is a node with the same children in the exact same order.
      -
      protected static booleanisNode(java.lang.Object obj) -
      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.
      -
      ActionResultonInvoke(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.
      -
      DSNodeput(DSInfo info, - DSIObject object) -
      Replaces the child.
      -
      DSInfoput(java.lang.String name, - boolean arg) -
      A convenience for put(String, DSIObject)
      -
      DSInfoput(java.lang.String name, - double arg) -
      A convenience for put(String, DSIObject)
      -
      DSInfoput(java.lang.String name, - DSIObject object) -
      Adds or replaces the named child.
      -
      DSInfoput(java.lang.String name, - float arg) -
      A convenience for put(String, DSIObject)
      -
      DSInfoput(java.lang.String name, - int arg) -
      A convenience for put(String, DSIObject)
      -
      DSInfoput(java.lang.String name, - long arg) -
      A convenience for put(String, DSIObject)
      -
      DSInfoput(java.lang.String name, - java.lang.String arg) -
      A convenience for put(String, DSIObject)
      -
      DSNoderemove(DSInfo info) -
      Removes the child.
      -
      DSInforemove(java.lang.String name) -
      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 DSNodetoNode(java.lang.Object obj) -
      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 java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.Iterable

        -forEach, spliterator
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        INFO_TOPIC

        -
        public static final DSTopic INFO_TOPIC
        -
        • -
      - - - -
        -
      • -

        VALUE_TOPIC

        -
        public static final DSTopic VALUE_TOPIC
        -
        • -
      -
      • -
    - -
      -
    • - - -

      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.
        -
        • -
      - - - -
        -
      • -

        clear

        -
        public DSNode clear()
        -
        Removes non-permanent children.
        -
        -
        Returns:
        -
        this
        -
        -
        • -
      - - - -
        -
      • -

        contains

        -
        public boolean contains(java.lang.String key)
        -
        Whether or not this node has a child with the given name.
        -
        • -
      - - - -
        -
      • -

        copy

        -
        public DSNode copy()
        -
        Returns a clone of this node and its subtree.
        -
        -
        Specified by:
        -
        copy in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        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
        -
        -
        • -
      - - - -
        -
      • -

        get

        -
        public DSIObject get(java.lang.String name)
        -
        Returns the child value with the given name, or null.
        -
        -
        Returns:
        -
        Possibly null.
        -
        -
        • -
      - - - -
        -
      • -

        getElement

        -
        public DSElement getElement(java.lang.String name)
        -
        A convenience for (DSElement) get(name).
        -
        • -
      - - - -
        -
      • -

        getInfo

        -
        public DSInfo getInfo()
        -
        DSInfo for this node in its parent, or null if un-parented.
        -
        • -
      - - - -
        -
      • -

        getInfo

        -
        public DSInfo getInfo(java.lang.String name)
        -
        Returns the info for the child with the given name, or null.
        -
        -
        Returns:
        -
        Possibly null.
        -
        -
        • -
      - - - -
        -
      • -

        getFirst

        -
        public DSIObject getFirst()
        -
        The first child, or null.
        -
        • -
      - - - -
        -
      • -

        getFirstInfo

        -
        public DSInfo getFirstInfo()
        -
        The first child info, or null.
        -
        • -
      - - - -
        -
      • -

        getFirstNodeInfo

        -
        public DSInfo getFirstNodeInfo()
        -
        The info for the first child node, or null.
        -
        • -
      - - - -
        -
      • -

        getLast

        -
        public DSIObject getLast()
        -
        The last child, or null.
        -
        • -
      - - - -
        -
      • -

        getLastInfo

        -
        public DSInfo getLastInfo()
        -
        The last child info, or null.
        -
        • -
      - - - -
        -
      • -

        getLogName

        -
        protected java.lang.String getLogName()
        -
        Description copied from class: DSLogger
        -
        Override point, returns the simple class name by default.
        -
        -
        Overrides:
        -
        getLogName in class DSLogger
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        getNode

        -
        public DSNode getNode(java.lang.String name)
        -
        A convenience for (DSNode) get(name).
        -
        • -
      - - - -
        -
      • -

        getParent

        -
        public DSNode getParent()
        -
        Returns the parent node, or null.
        -
        • -
      - - - -
        -
      • -

        getPath

        -
        public java.lang.String getPath()
        -
        The DSA path, properly encoded.
        -
        • -
      - - - -
        -
      • -

        getValue

        -
        public DSIValue getValue(java.lang.String name)
        -
        A convenience for (DSIValue) get(name).
        -
        • -
      - - - -
        -
      • -

        isDefaultInstance

        -
        protected final boolean isDefaultInstance()
        -
        True if this is the default instance for the type.
        -
        • -
      - - - -
        -
      • -

        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 in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isIdentical

        -
        public boolean isIdentical(java.lang.Object arg)
        -
        True if the argument is a node with the same children in the exact same order.
        -
        • -
      - - - -
        -
      • -

        isNode

        -
        protected static final boolean isNode(java.lang.Object obj)
        -
        Convenience for instanceof DSNode.
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Returns false.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isRunning

        -
        public boolean isRunning()
        -
        A convenience for !isStopped().
        -
        • -
      - - - -
        -
      • -

        isStable

        -
        public boolean isStable()
        -
        True after stable is called, children are stable before their parents.
        -
        • -
      - - - -
        -
      • -

        isStarted

        -
        public boolean isStarted()
        -
        True after start is called, children are started before their parents.
        -
        • -
      - - - -
        -
      • -

        isStopped

        -
        public boolean isStopped()
        -
        True after stop is called, children are stopped before their parents.
        -
        • -
      - - - -
        -
      • -

        isSubscribed

        -
        public boolean isSubscribed()
        -
        True if there are any subscribers.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        isSubscribed

        -
        public boolean isSubscribed(DSTopic topic)
        -
        True if there any subscriptions for the given topic.
        -
        • -
      - - - -
        -
      • -

        iterateNodes

        -
        public java.util.Iterator<DSInfo> iterateNodes()
        -
        Returns an info iterator of child DSNodes.
        -
        • -
      - - - -
        -
      • -

        iterateValues

        -
        public java.util.Iterator<DSInfo> iterateValues()
        -
        Returns an info iterator of child DSIValues.
        -
        • -
      - - - -
        -
      • -

        iterator

        -
        public java.util.Iterator<DSInfo> iterator()
        -
        Returns an info iterator of all children.
        -
        -
        Specified by:
        -
        iterator in interface java.lang.Iterable<DSInfo>
        -
        -
        • -
      - - - -
        -
      • -

        onChildAdded

        -
        protected void onChildAdded(DSInfo info)
        -
        Called when the given child is added and in the stable state.
        -
        • -
      - - - -
        -
      • -

        onChildChanged

        -
        protected void onChildChanged(DSInfo info)
        -
        Called when the given child is changed and in the stable state.
        -
        • -
      - - - -
        -
      • -

        onChildRemoved

        -
        protected void onChildRemoved(DSInfo info)
        -
        Called when the given child is removed and in the stable state.
        -
        • -
      - - - -
        -
      • -

        onInfoChanged

        -
        protected void onInfoChanged(DSInfo info)
        -
        Called when the given info is modified and in the stable state.
        -
        • -
      - - - -
        -
      • -

        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()
        -
        Called when this node transitions from having no subscriptions to having a subscription of - any kind.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        onStable

        -
        protected void onStable()
        -
        Called once this node is stable, but before stable is called on children.
        -
        • -
      - - - -
        -
      • -

        onStarted

        -
        protected void onStarted()
        -
        Called once this node and its entire subtree is started.
        -
        • -
      - - - -
        -
      • -

        onStopped

        -
        protected void onStopped()
        -
        Called once this node and its entire subtree is stopped.
        -
        • -
      - - - -
        -
      • -

        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()
        -
        Called when this node transitions to having no subscriptions of any kind.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        put

        -
        public DSNode put(DSInfo info,
-                  DSIObject object)
        -
        Replaces the child.
        -
        -
        Returns:
        -
        This
        -
        -
        • -
      - - - -
        -
      • -

        remove

        -
        public DSNode remove(DSInfo info)
        -
        Removes the child.
        -
        -
        Returns:
        -
        This
        -
        Throws:
        -
        java.lang.IllegalStateException - If the info is permanent or not a child of this node.
        -
        -
        • -
      - - - -
        -
      • -

        remove

        -
        public DSInfo remove(java.lang.String name)
        -
        Remove the named child if it is contained.
        -
        -
        Returns:
        -
        The removed info, or null.
        -
        Throws:
        -
        java.lang.IllegalStateException - If the info says its not removable.
        -
        -
        • -
      - - - -
        -
      • -

        stable

        -
        public final void stable()
        -
        Called after the entire subtree is started. Will call onStable after the entire subtree is - stable.
        -
        • -
      - - - -
        -
      • -

        start

        -
        public final void start()
        -
        Sets the state to starting. Calls onStarted once the entire subtree is started.
        -
        • -
      - - - -
        -
      • -

        stop

        -
        public final void stop()
        -
        Sets the state to stopped. Will call onStop before child nodes are stopped, and - onChildrenStopped after all child nodes are stopped.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        toNode

        -
        protected static DSNode toNode(java.lang.Object obj)
        -
        A convenience that casts the argument to a node.
        -
        • -
      - - - -
        -
      • -

        unsubscribe

        -
        public void unsubscribe(DSTopic topic,
-                        DSInfo child,
-                        DSISubscriber subscriber)
        -
        Unsubscribes the tuple.
        -
        -
        Parameters:
        -
        topic - Can not be null.
        -
        child - Can be null.
        -
        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
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSNull.html b/docs/javadoc/org/iot/dsa/node/DSNull.html deleted file mode 100644 index 836ff3e9..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSNull.html +++ /dev/null @@ -1,456 +0,0 @@ - - - - - -DSNull (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSNull

-
-
- -
-
    -
  • -
    -
    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).
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSPath.html b/docs/javadoc/org/iot/dsa/node/DSPath.html deleted file mode 100644 index a1a3e813..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSPath.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - -DSPath (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSPath

-
-
- -
-
    -
  • -
    -
    -
    public class DSPath
-extends java.lang.Object
    -
    Represents a path in the node tree. Not necessarily a valid one!
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSPath(java.lang.String path) 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.lang.StringBuilderconcat(java.lang.String leading, - java.lang.String trailing, - java.lang.StringBuilder bucket) -
      Concatenates the two paths into the given bucket.
      -
      static java.lang.StringdecodeName(java.lang.String pathName) -
      Un-escapes a name.
      -
      static java.lang.String[]decodePath(java.lang.String path) -
      Splits the path and decodes each individual name.
      -
      static java.lang.StringencodeName(java.lang.String name) -
      Encodes a name for being in a path.
      -
      static booleanencodeName(java.lang.String name, - java.lang.StringBuilder buf) -
      Encodes a name for being in a path.
      -
      static booleanencodeNameV1(java.lang.String name, - java.lang.StringBuilder buf) -
      Encodes a DSA v1 name for use outside of a path.
      -
      static java.lang.StringencodePath(boolean leadingSlash, - java.lang.String... names) -
      Creates a properly encoded path from the given names.
      -
      static java.lang.StringencodePath(boolean leadingSlash, - java.lang.String[] names, - int len) -
      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(java.lang.String path) -
      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

      - - - -
        -
      • -

        DSPath

        -
        public DSPath(java.lang.String path)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      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.
        -
        -
        • -
      - - - -
        -
      • -

        decodeName

        -
        public static java.lang.String decodeName(java.lang.String pathName)
        -
        Un-escapes a name.
        -
        • -
      - - - -
        -
      • -

        decodePath

        -
        public static java.lang.String[] decodePath(java.lang.String path)
        -
        Splits the path and decodes each individual name.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        encodePath

        -
        public static java.lang.String encodePath(DSNode node)
        -
        Ascends the tree and encodes all the node names into a path.
        -
        • -
      - - - -
        -
      • -

        encodeName

        -
        public static java.lang.String encodeName(java.lang.String name)
        -
        Encodes a name for being in a path.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        getLastPathElement

        -
        public java.lang.String getLastPathElement()
        -
        • -
      - - - -
        -
      • -

        getPath

        -
        public java.lang.String getPath()
        -
        The raw fully encoded path.
        -
        • -
      - - - -
        -
      • -

        getPathElements

        -
        public java.lang.String[] getPathElements()
        -
        The individual, decoded path elements.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSRegistry.html b/docs/javadoc/org/iot/dsa/node/DSRegistry.html deleted file mode 100644 index 7c3acfa3..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSRegistry.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - -DSRegistry (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSRegistry

-
-
- -
-
    -
  • -
    -
    -
    public class DSRegistry
-extends java.lang.Object
    -
    Static type related meta-data.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSRegistry() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSIValuegetDecoder(java.lang.Class clazz) -
      The instance to use for decoding.
      -
      static voidregisterDecoder(java.lang.Class clazz, - DSIValue instance) -
      DSIValues must provide an instance for decoding.
      -
      -
        -
      • - - -

        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

      - - - -
        -
      • -

        getDecoder

        -
        public static DSIValue getDecoder(java.lang.Class clazz)
        -
        The instance to use for decoding.
        -
        -
        Parameters:
        -
        clazz - The class of a value type.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSStatus.html b/docs/javadoc/org/iot/dsa/node/DSStatus.html deleted file mode 100644 index 70431d50..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSStatus.html +++ /dev/null @@ -1,1568 +0,0 @@ - - - - - -DSStatus (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSStatus

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject, DSIStatus, DSIStorable, DSIValue
    -
    -
    -
    -
    public class DSStatus
-extends DSValue
-implements DSIStatus, DSIStorable
    -
    Represent the health, quality or condition of an object. - -

    - - There are two categories of status, good and bad. Bad status means values can not be trusted and - should not be used in decision making / calculations. When performing aggregations / intervals, - bad values should be ignored if good values are present. - - -

    - - Remote status means the status is being reported by a foreign system (outside of DSA). This - should greatly help with troubleshooting. - - -

    - - Only the highest priority status should be assigned to an object. - - The status values in order from lowest to highest priority: - -

      - -
    • ok = Good, no other status applies. Implied when not present. - -
    • override = Good, the value is overridden within DSA. - -
    • remoteOverride = Good, the remote system is reporting the value is overridden. - -
    • stale = Bad, the value hasn't updated in a reasonable amount of time (user - configurable on a per point basis) within DSA. - -
    • down = Bad, communications are down in DSA. - -
    • fault = Bad, an operational error (exception) has occurred within DSA. - -
    • configFault = Bad, a configuration error has been identified within DSA. - -
    • disabled = Bad, the object has been disabled within DSA. - -
    • unknown = Bad, the status is unknown within DSA, typically the initial state at - boot. - -
    • remoteStale = Bad, a stale value is being reported by the remote system. - -
    • remoteDown = Bad, down communications are being reported by the remote system. - -
    • remoteFault = Bad, an operational error is being reported by the remote system. - -
    • remoteConfigFault = Bad, a configuration error is being reported by the remote system. - -
    • remoteDisabled = Bad, the remote system is reporting the object is disabled. - -
    • remoteUnknown = Bad, the remote system is reporting the status is unknown. - -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NULL

        -
        public static final DSStatus NULL
        -
        • -
      - - - -
        -
      • -

        OK

        -
        public static final int OK
        -
        Good, no other status applies.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        OK_OVERRIDE

        -
        public static final int OK_OVERRIDE
        -
        Good, the value is overridden within DSA.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        OK_REMOTE_OVERRIDE

        -
        public static final int OK_REMOTE_OVERRIDE
        -
        Good, the value is overridden outside of DSA.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        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
        -
        -
        • -
      - - - -
        -
      • -

        DOWN

        -
        public static final int DOWN
        -
        Bad, communications are down within DSA.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        FAULT

        -
        public static final int FAULT
        -
        Bad, an operational error (exception) has occurred within DSA.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        CONFIG_FAULT

        -
        public static final int CONFIG_FAULT
        -
        Bad, a configuration error has been indentified within DSA.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        DISABLED

        -
        public static final int DISABLED
        -
        Bad, the object has been disabled 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_STALE

        -
        public static final int REMOTE_STALE
        -
        Bad, a stale value is being reported by the foreign system.
        -
        -
        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
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_DISABLED

        -
        public static final int REMOTE_DISABLED
        -
        Bad, the foreign system is reporting the object is disabled.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_UNKNOWN

        -
        public static final int REMOTE_UNKNOWN
        -
        Bad, the foreign system is reporting the status is unknown.
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - - - - - -
        -
      • -

        OK_OVERRIDE_STR

        -
        public static final java.lang.String OK_OVERRIDE_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        OK_REMOTE_OVERRIDE_STR

        -
        public static final java.lang.String OK_REMOTE_OVERRIDE_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        CONFIG_FAULT_STR

        -
        public static final java.lang.String CONFIG_FAULT_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - - - - - -
        -
      • -

        DISABLED_STR

        -
        public static final java.lang.String DISABLED_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        UNKNOWN_STR

        -
        public static final java.lang.String UNKNOWN_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_STALE_STR

        -
        public static final java.lang.String REMOTE_STALE_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_DOWN_STR

        -
        public static final java.lang.String REMOTE_DOWN_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_FAULT_STR

        -
        public static final java.lang.String REMOTE_FAULT_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_CONFIG_FAULT_STR

        -
        public static final java.lang.String REMOTE_CONFIG_FAULT_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_DISABLED_STR

        -
        public static final java.lang.String REMOTE_DISABLED_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        REMOTE_UNKNOWN_STR

        -
        public static final java.lang.String REMOTE_UNKNOWN_STR
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
        • -
      - - - -
        -
      • -

        ok

        -
        public static final DSStatus ok
        -
        • -
      - - - -
        -
      • -

        okOverride

        -
        public static final DSStatus okOverride
        -
        • -
      - - - -
        -
      • -

        okRemoteOverride

        -
        public static final DSStatus okRemoteOverride
        -
        • -
      - - - -
        -
      • -

        stale

        -
        public static final DSStatus stale
        -
        • -
      - - - -
        -
      • -

        down

        -
        public static final DSStatus down
        -
        • -
      - - - -
        -
      • -

        fault

        -
        public static final DSStatus fault
        -
        • -
      - - - -
        -
      • -

        configFault

        -
        public static final DSStatus configFault
        -
        • -
      - - - -
        -
      • -

        disabled

        -
        public static final DSStatus disabled
        -
        • -
      - - - -
        -
      • -

        unknown

        -
        public static final DSStatus unknown
        -
        • -
      - - - -
        -
      • -

        remoteStale

        -
        public static final DSStatus remoteStale
        -
        • -
      - - - -
        -
      • -

        remoteDown

        -
        public static final DSStatus remoteDown
        -
        • -
      - - - -
        -
      • -

        remoteFault

        -
        public static final DSStatus remoteFault
        -
        • -
      - - - -
        -
      • -

        remoteConfigFault

        -
        public static final DSStatus remoteConfigFault
        -
        • -
      - - - -
        -
      • -

        remoteDisabled

        -
        public static final DSStatus remoteDisabled
        -
        • -
      - - - -
        -
      • -

        remoteUnknown

        -
        public static final DSStatus remoteUnknown
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object obj)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isBad

        -
        public boolean isBad()
        -
        If any of the bad flags are set, or is null.
        -
        • -
      - - - -
        -
      • -

        isConfigFault

        -
        public boolean isConfigFault()
        -
        True if the associate bit is set.
        -
        • -
      - - - -
        -
      • -

        isDisabled

        -
        public boolean isDisabled()
        -
        True if the associate bit is set.
        -
        • -
      - - - -
        -
      • -

        isDown

        -
        public boolean isDown()
        -
        True if the associate bit is set.
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isFault

        -
        public boolean isFault()
        -
        True if the associate bit is set.
        -
        • -
      - - - -
        -
      • -

        isGood

        -
        public boolean isGood()
        -
        If true, any associate object / value can be trusted.
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        isOk

        -
        public boolean isOk()
        -
        • -
      - - - -
        -
      • -

        isOverride

        -
        public boolean isOverride()
        -
        True if the associate bit is set.
        -
        • -
      - - - -
        -
      • -

        isRemoteConfigFault

        -
        public boolean isRemoteConfigFault()
        -
        • -
      - - - -
        -
      • -

        isRemoteDisabled

        -
        public boolean isRemoteDisabled()
        -
        • -
      - - - -
        -
      • -

        isRemoteDown

        -
        public boolean isRemoteDown()
        -
        • -
      - - - -
        -
      • -

        isRemoteFault

        -
        public boolean isRemoteFault()
        -
        • -
      - - - -
        -
      • -

        isRemoteOverride

        -
        public boolean isRemoteOverride()
        -
        • -
      - - - -
        -
      • -

        isRemoteStale

        -
        public boolean isRemoteStale()
        -
        • -
      - - - -
        -
      • -

        isRemoteUnknown

        -
        public boolean isRemoteUnknown()
        -
        • -
      - - - -
        -
      • -

        isStale

        -
        public boolean isStale()
        -
        • -
      - - - -
        -
      • -

        isUnknown

        -
        public boolean isUnknown()
        -
        • -
      - - - -
        -
      • -

        store

        -
        public DSLong store()
        -
        Description copied from interface: DSIStorable
        -
        Serialize the value for the configuration database. Can be a different element type than - toElement().
        -
        -
        Specified by:
        -
        store in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public DSStatus restore(DSElement arg)
        -
        Description copied from interface: DSIStorable
        -
        Deserialize a value from the configuration database, these will be values returned from the - store() method.
        -
        -
        Specified by:
        -
        restore in interface 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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class 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 in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSStatus valueOf(java.lang.String string)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSString.html b/docs/javadoc/org/iot/dsa/node/DSString.html deleted file mode 100644 index 7a8eb457..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSString.html +++ /dev/null @@ -1,491 +0,0 @@ - - - - - -DSString (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSString

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        EMPTY

        -
        public static final DSString EMPTY
        -
        The string of length 0.
        -
        • -
      - - - -
        -
      • -

        NULL

        -
        public static final DSString NULL
        -
        • -
      - - - -
        -
      • -

        UTF8

        -
        public static final java.nio.charset.Charset UTF8
        -
        The standard UTF8 charset, can be used with string.getBytes(Charset).
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object o)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isString

        -
        public boolean isString()
        -
        Description copied from class: DSElement
        -
        Whether or not the object represents a string.
        -
        -
        Overrides:
        -
        isString in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toBoolean

        -
        public boolean toBoolean()
        -
        Description copied from class: DSElement
        -
        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 in class DSElement
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      - - - - - - - -
        -
      • -

        valueOf

        -
        public static DSString valueOf(java.lang.Object arg)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSValue.html b/docs/javadoc/org/iot/dsa/node/DSValue.html deleted file mode 100644 index d11048cf..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSValue.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - -DSValue (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node
-

Class DSValue

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSValue() 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      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
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSValueNode.html b/docs/javadoc/org/iot/dsa/node/DSValueNode.html deleted file mode 100644 index c295db89..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSValueNode.html +++ /dev/null @@ -1,470 +0,0 @@ - - - - - -DSValueNode (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node
-

Class DSValueNode

-
-
- -
-
    -
  • -
    -
    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()
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DSValueNode

        -
        public DSValueNode()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        onChildChanged

        -
        public void onChildChanged(DSInfo child)
        -
        This fires the NODE_CHANGED topic when the value child changes. Overrides should call - super.onChildChanged.
        -
        -
        Overrides:
        -
        onChildChanged in class DSNode
        -
        -
        • -
      - - - - - - - -
        -
      • -

        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 in interface 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 in class 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 in interface DSIValue
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/DSValueType.html b/docs/javadoc/org/iot/dsa/node/DSValueType.html deleted file mode 100644 index 7caaf291..00000000 --- a/docs/javadoc/org/iot/dsa/node/DSValueType.html +++ /dev/null @@ -1,430 +0,0 @@ - - - - - -DSValueType (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node
-

Enum 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.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringtoString() 
      static DSValueTypevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static DSValueType[]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, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static DSValueType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DSValueType c : DSValueType.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Enum<DSValueType>
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/ActionInvocation.html b/docs/javadoc/org/iot/dsa/node/action/ActionInvocation.html deleted file mode 100644 index 646eb79f..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/ActionInvocation.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - -ActionInvocation (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.action
-

Interface ActionInvocation

-
-
-
-
    -
  • -
    -
    All Known Subinterfaces:
    -
    InboundInvokeRequest
    -
    -
    -
    -
    public interface ActionInvocation
    -
    Encapsulates the details of an action invocation and provides the mechanism for updating and open - stream. - - The action
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod 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(java.lang.Exception reason) -
      Close and send and error.
      -
      DSMapgetParameters() -
      The parameters supplied by the requester, or null.
      -
      DSPermissiongetPermission() -
      The permission level of the invoker, should be verified against the permission level required - by the action.
      -
      voidinsert(int index, - DSList... rows) -
      Only use with open tables, insert the rows at the given index.
      -
      booleanisOpen() -
      Whether or not response is still open.
      -
      voidreplace(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.
      -
      voidsend(DSList row) -
      Only use with stream and open tables.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        clearAllRows

        -
        void clearAllRows()
        -
        Only use with stream and open tables, instructs the requester to clear all existing rows.
        -
        • -
      - - - -
        -
      • -

        close

        -
        void close()
        -
        For use with streams and open tables, will have no effect if the stream is already closed.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        getParameters

        -
        DSMap getParameters()
        -
        The parameters supplied by the requester, or null.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        isOpen

        -
        boolean isOpen()
        -
        Whether or not response is still open.
        -
        • -
      - - - -
        -
      • -

        send

        -
        void send(DSList row)
        -
        Only use with stream and open tables. Should not be called until the initial row iterator is - complete, otherwise the update buffer could grow very large.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/ActionResult.html b/docs/javadoc/org/iot/dsa/node/action/ActionResult.html deleted file mode 100644 index e224d5e2..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/ActionResult.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - -ActionResult (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.action
-

Interface ActionResult

-
-
-
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAction

        -
        ActionSpec getAction()
        -
        The action that was invoked. This is needed for custom DSResponder implementations where the - action is unknown.
        -
        • -
      - - - -
        -
      • -

        onClose

        -
        void onClose()
        -
        Always called, whether or not the result is a stream, and no matter who closes it.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/ActionSpec.ResultType.html b/docs/javadoc/org/iot/dsa/node/action/ActionSpec.ResultType.html deleted file mode 100644 index 512c4901..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/ActionSpec.ResultType.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - -ActionSpec.ResultType (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node.action
-

Enum ActionSpec.ResultType

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<ActionSpec.ResultType>
    -
    -
    -
    Enclosing interface:
    -
    ActionSpec
    -
    -
    -
    -
    public static enum ActionSpec.ResultType
-extends java.lang.Enum<ActionSpec.ResultType>
    -
    Defines what the action returns.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      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

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanisClosed() -
      True if CLOSED_TABLE, VOID, or VALUES.
      -
      booleanisOpen() -
      True if OPEN_TABLE or STREAM_TABLE
      -
      booleanisStream() -
      True if this is the STREAM_TABLE.
      -
      booleanisValues() 
      booleanisVoid() 
      java.lang.StringtoString() 
      static ActionSpec.ResultTypevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static ActionSpec.ResultType[]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, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        CLOSED_TABLE

        -
        public static final ActionSpec.ResultType CLOSED_TABLE
        -
        A finite sized table whose stream is closed when the row iterator is complete.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        STREAM_TABLE

        -
        public static final ActionSpec.ResultType STREAM_TABLE
        -
        A stream of rows. Clients can choose to trim rows for memory management.
        -
        • -
      - - - - - - - - -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static ActionSpec.ResultType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (ActionSpec.ResultType c : ActionSpec.ResultType.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      - - - -
        -
      • -

        isClosed

        -
        public boolean isClosed()
        -
        True if CLOSED_TABLE, VOID, or VALUES.
        -
        • -
      - - - -
        -
      • -

        isOpen

        -
        public boolean isOpen()
        -
        True if OPEN_TABLE or STREAM_TABLE
        -
        • -
      - - - -
        -
      • -

        isStream

        -
        public boolean isStream()
        -
        True if this is the STREAM_TABLE.
        -
        • -
      - - - -
        -
      • -

        isVoid

        -
        public boolean isVoid()
        -
        • -
      - - - -
        -
      • -

        isValues

        -
        public boolean isValues()
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Enum<ActionSpec.ResultType>
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/ActionSpec.html b/docs/javadoc/org/iot/dsa/node/action/ActionSpec.html deleted file mode 100644 index 9ec089d2..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/ActionSpec.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - -ActionSpec (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.action
-

Interface ActionSpec

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    DSAction
    -
    -
    -
    -
    public interface ActionSpec
    -
    Defines an invokable node in the DSA model.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getParameters

        -
        java.util.Iterator<DSMap> getParameters()
        -
        Returns an iterator for each parameter.
        -
        -
        Returns:
        -
        Null if there are no parameters.
        -
        -
        • -
      - - - -
        -
      • -

        getPermission

        -
        DSPermission getPermission()
        -
        Minimum permission level required to invoke.
        -
        -
        Returns:
        -
        Never null.
        -
        -
        • -
      - - - - - - - -
        -
      • -

        getValueResults

        -
        java.util.Iterator<DSMap> getValueResults()
        -
        This is only called for the VALUES result type.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/ActionTable.html b/docs/javadoc/org/iot/dsa/node/action/ActionTable.html deleted file mode 100644 index c1314709..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/ActionTable.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - -ActionTable (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.action
-

Interface ActionTable

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    ActionResult
    -
    -
    -
    -
    public interface ActionTable
-extends ActionResult
    -
    Provides access to the columns and rows of a table. Not thread safe and only represents the - result of a single action invocation.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/ActionValues.html b/docs/javadoc/org/iot/dsa/node/action/ActionValues.html deleted file mode 100644 index 7daa3006..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/ActionValues.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - -ActionValues (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.action
-

Interface ActionValues

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    ActionResult
    -
    -
    -
    All Known Implementing Classes:
    -
    DSActionValues
    -
    -
    -
    -
    public interface ActionValues
-extends ActionResult
    -
    Simple set of return values from an action.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getValues

        -
        java.util.Iterator<DSIValue> getValues()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/DSAction.html b/docs/javadoc/org/iot/dsa/node/action/DSAction.html deleted file mode 100644 index fed0aa4a..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/DSAction.html +++ /dev/null @@ -1,739 +0,0 @@ - - - - - -DSAction (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node.action
-

Class 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)
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSActionDEFAULT -
      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 TypeMethod and Description
      DSMetadataaddDefaultParameter(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.
      -
      DSActionaddParameter(DSMap metadata) -
      Fully describes a parameter for method invocation.
      -
      DSMetadataaddParameter(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.
      -
      DSMetadataaddParameter(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.
      -
      DSActionaddValueResult(DSMap metadata) -
      Fully describes a return value when the result type is VALUES.
      -
      DSMetadataaddValueResult(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.
      -
      DSMetadataaddValueResult(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.
      -
      DSActioncopy() -
      Return a copy if it makes sense, but return this otherwise.
      -
      java.util.Iterator<DSMap>getParameters() -
      Returns an iterator for each parameter.
      -
      DSPermissiongetPermission() -
      Not used.
      -
      ActionSpec.ResultTypegetResultType() -
      What the action returns.
      -
      java.util.Iterator<DSMap>getValueResults() -
      This is only called for the VALUES result type.
      -
      ActionResultinvoke(DSInfo info, - ActionInvocation invocation) -
      Calls onInvoke on the proper node.
      -
      booleanisEqual(java.lang.Object obj) -
      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.
      -
      DSActionsetResultType(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

      - - - -
        -
      • -

        copy

        -
        public DSAction copy()
        -
        Description copied from interface: DSIObject
        -
        Return a copy if it makes sense, but return this otherwise.
        -
        -
        Specified by:
        -
        copy in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        getParameters

        -
        public java.util.Iterator<DSMap> getParameters()
        -
        Description copied from interface: ActionSpec
        -
        Returns an iterator for each parameter.
        -
        -
        Specified by:
        -
        getParameters in interface ActionSpec
        -
        Returns:
        -
        Null if there are no parameters.
        -
        -
        • -
      - - - -
        -
      • -

        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 in interface ActionSpec
        -
        Returns:
        -
        Never null.
        -
        -
        • -
      - - - - - - - -
        -
      • -

        getValueResults

        -
        public java.util.Iterator<DSMap> getValueResults()
        -
        Description copied from interface: ActionSpec
        -
        This is only called for the VALUES result type.
        -
        -
        Specified by:
        -
        getValueResults in interface ActionSpec
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Defaults to the equals method.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        False
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        setResultType

        -
        public DSAction setResultType(ActionSpec.ResultType result)
        -
        Returns this, it is not necessary to set the result to void.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/DSActionValues.html b/docs/javadoc/org/iot/dsa/node/action/DSActionValues.html deleted file mode 100644 index d06081b3..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/DSActionValues.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - -DSActionValues (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node.action
-

Class 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 Detail

      - - - -
        -
      • -

        DSActionValues

        -
        public DSActionValues(DSAction action)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addResult

        -
        public DSActionValues addResult(DSIValue value)
        -
        Values must be added in the same order they were defined in the action.
        -
        • -
      - - - -
        -
      • -

        getAction

        -
        public DSAction getAction()
        -
        Description copied from interface: ActionResult
        -
        The action that was invoked. This is needed for custom DSResponder implementations where the - action is unknown.
        -
        -
        Specified by:
        -
        getAction in interface ActionResult
        -
        -
        • -
      - - - - - - - -
        -
      • -

        onClose

        -
        public void onClose()
        -
        Does nothing.
        -
        -
        Specified by:
        -
        onClose in interface ActionResult
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/package-frame.html b/docs/javadoc/org/iot/dsa/node/action/package-frame.html deleted file mode 100644 index f0ef4a7d..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/package-frame.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - -org.iot.dsa.node.action (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.node.action

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/docs/javadoc/org/iot/dsa/node/action/package-summary.html b/docs/javadoc/org/iot/dsa/node/action/package-summary.html deleted file mode 100644 index 10e3f2ec..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/package-summary.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - -org.iot.dsa.node.action (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.node.action

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/action/package-tree.html b/docs/javadoc/org/iot/dsa/node/action/package-tree.html deleted file mode 100644 index 183fc1cc..00000000 --- a/docs/javadoc/org/iot/dsa/node/action/package-tree.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - -org.iot.dsa.node.action Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.node.action

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/DSIEvent.html b/docs/javadoc/org/iot/dsa/node/event/DSIEvent.html deleted file mode 100644 index 6273761b..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/DSIEvent.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - -DSIEvent (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.event
-

Interface DSIEvent

-
-
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/DSISubscriber.html b/docs/javadoc/org/iot/dsa/node/event/DSISubscriber.html deleted file mode 100644 index 137254c1..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/DSISubscriber.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - -DSISubscriber (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.event
-

Interface DSISubscriber

-
-
-
-
    -
  • -
    -
    -
    public interface DSISubscriber
    -
    DSISubscribers subscribe to DSTopics on DSNodes. -

    - A single topic can emanate multiple types of events. The event object is an empty interface, - each topic will define it's own events. -

    - Events can also supply parameters. The parameters specific to each kind of event. -

    - See the class documentation of a specific topic to understand the possible events and their - parameters. -

    - The two most important topics are built into every node, they are: DSValueTopic and DSInfoTopic.

    -
    -
    See Also:
    -
    DSIEvent, -DSTopic, -DSNode.subscribe(DSTopic, DSInfo, DSISubscriber)
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.Event.html b/docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.Event.html deleted file mode 100644 index 204382f4..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.Event.html +++ /dev/null @@ -1,366 +0,0 @@ - - - - - -DSInfoTopic.Event (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node.event
-

Enum 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

      - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSInfoTopic.EventvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static DSInfoTopic.Event[]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
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      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.
        -
        • -
      - - - -
        -
      • -

        METADATA_CHANGED

        -
        public static final DSInfoTopic.Event METADATA_CHANGED
        -
        TBD. Node? Child? Both?
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static DSInfoTopic.Event[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DSInfoTopic.Event c : DSInfoTopic.Event.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.html b/docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.html deleted file mode 100644 index c20222ca..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/DSInfoTopic.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - -DSInfoTopic (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.event
-

Class DSInfoTopic

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject
    -
    -
    -
    -
    public class DSInfoTopic
-extends DSTopic
    -
    This topic is for info related events on DSNodes. -

    - Events will be on of the enum defined in the Event inner class. The parameters for each event - are defined in the documentation for each event.

    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass and Description
      static class DSInfoTopic.Event -
      The possible events for this topic.
      -
      -
      • -
    - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSInfoTopicINSTANCE -
      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
        • -
      -
      • -
    -
    • -
-
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/DSTopic.html b/docs/javadoc/org/iot/dsa/node/event/DSTopic.html deleted file mode 100644 index c58c4b6c..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/DSTopic.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - -DSTopic (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.node.event
-

Class DSTopic

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject
    -
    -
    -
    Direct Known Subclasses:
    -
    DSInfoTopic, DSValueTopic
    -
    -
    -
    -
    public class DSTopic
-extends java.lang.Object
-implements DSIObject
    -
    DSISubscribers subscribe to DSTopics on DSNodes. -

    - A single topic can emanate multiple types of events. The event object is an empty interface, - each topic will define it's own events. -

    - Events can also supply parameters. The parameters specific to each kind of event. -

    - See the class documentation of a specific topic to understand the possible events and their - parameters. -

    - The two most important topics are built into every node, they are: DSValueTopic and DSInfoTopic.

    -
    -
    See Also:
    -
    DSIEvent, -DSISubscriber, -DSInfoTopic, -DSValueTopic, -DSNode.subscribe(DSTopic, DSInfo, DSISubscriber)
    -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSTopic() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DSTopiccopy() -
      Returns this.
      -
      booleanisEqual(java.lang.Object obj) -
      Only test instance equality.
      -
      booleanisNull() -
      False
      -
      -
        -
      • - - -

        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

      - - - -
        -
      • -

        copy

        -
        public DSTopic copy()
        -
        Returns this.
        -
        -
        Specified by:
        -
        copy in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Only test instance equality.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        False
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/DSValueTopic.Event.html b/docs/javadoc/org/iot/dsa/node/event/DSValueTopic.Event.html deleted file mode 100644 index 6521d696..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/DSValueTopic.Event.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - -DSValueTopic.Event (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.node.event
-

Enum DSValueTopic.Event

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      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

      - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSValueTopic.EventvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static DSValueTopic.Event[]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
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        NODE_CHANGED

        -
        public static final DSValueTopic.Event NODE_CHANGED
        -
        For DSNodes that implement DSIValue. The DSInfo arg to onEvent must be null.
        -
        • -
      - - - -
        -
      • -

        CHILD_CHANGED

        -
        public static final DSValueTopic.Event CHILD_CHANGED
        -
        For node value children (who are not also nodes). The DSInfo arg must not be null.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static DSValueTopic.Event[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DSValueTopic.Event c : DSValueTopic.Event.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/DSValueTopic.html b/docs/javadoc/org/iot/dsa/node/event/DSValueTopic.html deleted file mode 100644 index 11996cb3..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/DSValueTopic.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - -DSValueTopic (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.node.event
-

Class DSValueTopic

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject, DSIEvent
    -
    -
    -
    -
    public class DSValueTopic
-extends DSTopic
-implements DSIEvent
    -
    This topic is for change of value events on DSNodes. There are two types of events, - NODE_CHANGED for nodes that implement DSIValue and CHILD_CHANGED for child values of the - subscribed node. -

    - Events will be one of the enums defined in the Event inner class.

    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass and Description
      static class DSValueTopic.Event -
      The possible events from this topic.
      -
      -
      • -
    - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSValueTopicINSTANCE -
      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
        • -
      -
      • -
    -
    • -
-
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/package-frame.html b/docs/javadoc/org/iot/dsa/node/event/package-frame.html deleted file mode 100644 index 3cb01120..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/package-frame.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - -org.iot.dsa.node.event (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.node.event

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/docs/javadoc/org/iot/dsa/node/event/package-summary.html b/docs/javadoc/org/iot/dsa/node/event/package-summary.html deleted file mode 100644 index 5b172acd..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/package-summary.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - -org.iot.dsa.node.event (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.node.event

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/event/package-tree.html b/docs/javadoc/org/iot/dsa/node/event/package-tree.html deleted file mode 100644 index e309f93a..00000000 --- a/docs/javadoc/org/iot/dsa/node/event/package-tree.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - -org.iot.dsa.node.event Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.node.event

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/package-frame.html b/docs/javadoc/org/iot/dsa/node/package-frame.html deleted file mode 100644 index 9b111288..00000000 --- a/docs/javadoc/org/iot/dsa/node/package-frame.html +++ /dev/null @@ -1,58 +0,0 @@ - - - - - -org.iot.dsa.node (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.node

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/docs/javadoc/org/iot/dsa/node/package-summary.html b/docs/javadoc/org/iot/dsa/node/package-summary.html deleted file mode 100644 index 4b36e315..00000000 --- a/docs/javadoc/org/iot/dsa/node/package-summary.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - - -org.iot.dsa.node (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.node

-
-
Persistent data model used to build the node tree of a link.
-
-

See: Description

-
-
- - - - -

Package org.iot.dsa.node Description

-
Persistent data model used to build the node tree of a link.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/node/package-tree.html b/docs/javadoc/org/iot/dsa/node/package-tree.html deleted file mode 100644 index cc63ed56..00000000 --- a/docs/javadoc/org/iot/dsa/node/package-tree.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - -org.iot.dsa.node Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.node

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/package-frame.html b/docs/javadoc/org/iot/dsa/package-frame.html deleted file mode 100644 index c4f6dbca..00000000 --- a/docs/javadoc/org/iot/dsa/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - -org.iot.dsa (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa

-
-

Classes

- -
- - diff --git a/docs/javadoc/org/iot/dsa/package-summary.html b/docs/javadoc/org/iot/dsa/package-summary.html deleted file mode 100644 index ef2a5be6..00000000 --- a/docs/javadoc/org/iot/dsa/package-summary.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - -org.iot.dsa (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa

-
-
Use the DSRuntime thread pool and timers.
-
-

See: Description

-
-
- - - - -

Package org.iot.dsa Description

-
Use the DSRuntime thread pool and timers.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/package-tree.html b/docs/javadoc/org/iot/dsa/package-tree.html deleted file mode 100644 index 25d0c349..00000000 --- a/docs/javadoc/org/iot/dsa/package-tree.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - -org.iot.dsa Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - 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 cc20307b..00000000 --- a/docs/javadoc/org/iot/dsa/security/DSIPassword.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - -DSIPassword (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.security
-

Interface DSIPassword

-
-
-
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isValid

        -
        boolean isValid(DSElement arg)
        -
        Returns true if the give element is valid according to the backing implementation.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/DSKeys.Signer.html b/docs/javadoc/org/iot/dsa/security/DSKeys.Signer.html deleted file mode 100644 index 7fe7b89a..00000000 --- a/docs/javadoc/org/iot/dsa/security/DSKeys.Signer.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - -DSKeys.Signer (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.security
-

Class 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(java.security.PrivateKey privateKey) 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]getSignature() -
      The signature for all bytes passed to the update method.
      -
      java.lang.StringgetSignatureBase64() -
      The base 64 encoding of the signature for all bytes passed to the update method.
      -
      DSKeys.Signerreset() -
      Call to begin a new signature.
      -
      DSKeys.Signerupdate(byte[] buf) -
      Update the signature with the given bytes.
      -
      DSKeys.Signerupdate(byte[] buf, - int off, - int len) -
      Update the signature with the given bytes.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Signer

        -
        public Signer(java.security.PrivateKey privateKey)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getSignature

        -
        public byte[] getSignature()
        -
        The signature for all bytes passed to the update method.
        -
        • -
      - - - -
        -
      • -

        getSignatureBase64

        -
        public java.lang.String getSignatureBase64()
        -
        The base 64 encoding of the signature for all bytes passed to the update method.
        -
        • -
      - - - -
        -
      • -

        reset

        -
        public DSKeys.Signer reset()
        -
        Call to begin a new signature.
        -
        • -
      - - - -
        -
      • -

        update

        -
        public DSKeys.Signer update(byte[] buf)
        -
        Update the signature with the given bytes.
        -
        -
        Parameters:
        -
        buf - The source of the bytes.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/DSKeys.Verifier.html b/docs/javadoc/org/iot/dsa/security/DSKeys.Verifier.html deleted file mode 100644 index fadabd92..00000000 --- a/docs/javadoc/org/iot/dsa/security/DSKeys.Verifier.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - -DSKeys.Verifier (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.security
-

Class 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(java.security.PublicKey publicKey) 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DSKeys.Verifierreset() -
      Call to begin a new signature.
      -
      DSKeys.Verifierupdate(byte[] buf) -
      Update the signature with the given bytes.
      -
      DSKeys.Verifierupdate(byte[] buf, - int off, - int len) -
      Update the signature with the given bytes.
      -
      booleanvalidate(byte[] signature) -
      Returns true if the given signature is valid for the bytes passed to update.
      -
      booleanvalidate(java.lang.String base64signature) -
      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

      - - - -
        -
      • -

        Verifier

        -
        public Verifier(java.security.PublicKey publicKey)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        reset

        -
        public DSKeys.Verifier reset()
        -
        Call to begin a new signature.
        -
        • -
      - - - -
        -
      • -

        update

        -
        public DSKeys.Verifier update(byte[] buf)
        -
        Update the signature with the given bytes.
        -
        -
        Parameters:
        -
        buf - The source of the bytes.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        validate

        -
        public boolean validate(byte[] signature)
        -
        Returns true if the given signature is valid for the bytes passed to update.
        -
        • -
      - - - -
        -
      • -

        validate

        -
        public boolean validate(java.lang.String base64signature)
        -
        Returns true if the given base 64 encoded signature is valid for the bytes passed to - update.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/DSKeys.html b/docs/javadoc/org/iot/dsa/security/DSKeys.html deleted file mode 100644 index fecea388..00000000 --- a/docs/javadoc/org/iot/dsa/security/DSKeys.html +++ /dev/null @@ -1,743 +0,0 @@ - - - - - -DSKeys (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.security
-

Class DSKeys

-
-
- -
-
    -
  • -
    -
    -
    public class DSKeys
-extends java.lang.Object
    -
    DSA public private key pair.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass and Description
      class DSKeys.Signer -
      Signs bytes.
      -
      static class DSKeys.Verifier -
      Verifies signatures.
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - -
      Constructors 
      Constructor and Description
      DSKeys(java.io.File keyFile) -
      Creates a DSKeys object by decoding existing keys from the given file.
      -
      DSKeys(java.security.KeyPair keyPair) -
      Creates a DSKeys object for an existing key pair.
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSKeysdecodeKeys(java.lang.String arg) -
      Decodes an instance that was encoded with encodeKeys().
      -
      static java.security.interfaces.ECPrivateKeydecodePrivate(byte[] bytes) -
      Decodes the X9.63 encoding of a public key.
      -
      static java.security.interfaces.ECPublicKeydecodePublic(byte[] bytes) -
      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[] data, - byte[] secretKeyBytes) 
      byte[]generateSharedSecret(byte[] publicKeyBytes) -
      Uses the given public key to generate an ECDH shared secret.
      -
      byte[]generateSharedSecret(java.lang.String base64key) -
      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.SignernewSigner() -
      Creates a signer for this private key.
      -
      DSKeys.VerifiernewVerifier() -
      Creates a verifier for this public key.
      -
      static DSKeysrestore(java.io.File file) -
      Decodes a key pair that was encoded by the store method.
      -
      static DSKeysrestore(java.io.InputStream in) -
      Decodes a key pair that was encoded by the store method, does not onClose the given stream.
      -
      java.lang.Stringsign(byte[] buf, - int off, - int len) -
      A convenience that creates a signer and signs the given bytes.
      -
      voidstore(java.io.File file) -
      Write the bytes from the string encoding to the given file.
      -
      voidstore(java.io.OutputStream out) -
      Writes the bytes from the string encoding to the given stream, does not onClose the stream.
      -
      booleanverify(byte[] buf, - int off, - int len, - java.lang.String signature) -
      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 - Wrapping underlying IOExceptions.
        -
        -
        • -
      - - - -
        -
      • -

        DSKeys

        -
        public DSKeys(java.security.KeyPair keyPair)
        -
        Creates a DSKeys object for an existing key pair.
        -
        -
        Parameters:
        -
        keyPair - Must represent the EC curve secp256r1.
        -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        decodeKeys

        -
        public static DSKeys decodeKeys(java.lang.String arg)
        -
        Decodes an instance that was encoded with encodeKeys().
        -
        -
        Parameters:
        -
        arg - String produced by encodeKeys().
        -
        -
        • -
      - - - -
        -
      • -

        decodePrivate

        -
        public static java.security.interfaces.ECPrivateKey decodePrivate(byte[] bytes)
        -
        Decodes the X9.63 encoding of a public key.
        -
        • -
      - - - -
        -
      • -

        decodePublic

        -
        public static java.security.interfaces.ECPublicKey decodePublic(byte[] bytes)
        -
        Decodes the X9.63 encoding of a public key.
        -
        • -
      - - - -
        -
      • -

        generateHmacSHA256Signature

        -
        public static byte[] generateHmacSHA256Signature(byte[] data,
-                                                 byte[] secretKeyBytes)
        -
        • -
      - - - -
        -
      • -

        generateSharedSecret

        -
        public byte[] generateSharedSecret(byte[] publicKeyBytes)
        -
        Uses the given public key to generate an ECDH shared secret.
        -
        -
        Parameters:
        -
        publicKeyBytes - Public key of the other party.
        -
        -
        • -
      - - - -
        -
      • -

        generateSharedSecret

        -
        public byte[] generateSharedSecret(java.lang.String base64key)
        -
        Uses the given public key to generate an ECDH shared secret.
        -
        -
        Parameters:
        -
        base64key - Base64 encoded public key of the other party.
        -
        -
        • -
      - - - -
        -
      • -

        encodeKeys

        -
        public java.lang.String encodeKeys()
        -
        Encodes the key pair which can be then decoded with decodeKeys().
        -
        • -
      - - - -
        -
      • -

        encodePublicHashDsId

        -
        public java.lang.String encodePublicHashDsId()
        -
        Base64 encoding (no padding and url safe) of the SHA256 hash of the public key. This is used - to generate the DSID of a link.
        -
        -
        Throws:
        -
        DSException - wrapping any security related exceptions.
        -
        -
        • -
      - - - -
        -
      • -

        encodePublic

        -
        public byte[] encodePublic()
        -
        X9.63 encoding of the public key.
        -
        • -
      - - - -
        -
      • -

        getParameters

        -
        public static java.security.spec.ECParameterSpec getParameters()
        -
        The AlgorithmParameterSpec for the predefined elliptic curve secp256r1.
        -
        • -
      - - - -
        -
      • -

        getKeys

        -
        public java.security.KeyPair getKeys()
        -
        The public and private keys.
        -
        • -
      - - - -
        -
      • -

        getPrivateKey

        -
        public java.security.interfaces.ECPrivateKey getPrivateKey()
        -
        A convenience that casts the private key.
        -
        • -
      - - - -
        -
      • -

        getPublicKey

        -
        public java.security.interfaces.ECPublicKey getPublicKey()
        -
        A convenience that casts the public key.
        -
        • -
      - - - -
        -
      • -

        newKeyPair

        -
        public static java.security.KeyPair newKeyPair()
        -
        Creates a key pair for the predefined elliptic curve secp256r1.
        -
        -
        Throws:
        -
        DSException - Wrapping underlying security exceptions.
        -
        -
        • -
      - - - -
        -
      • -

        newSignature

        -
        public static java.security.Signature newSignature()
        -
        Returns a SHA256withECDSA signature.
        -
        -
        Throws:
        -
        DSException - Wrapping underlying security exceptions.
        -
        -
        • -
      - - - -
        -
      • -

        newSigner

        -
        public DSKeys.Signer newSigner()
        -
        Creates a signer for this private key.
        -
        • -
      - - - -
        -
      • -

        newVerifier

        -
        public DSKeys.Verifier newVerifier()
        -
        Creates a verifier for this public key.
        -
        • -
      - - - -
        -
      • -

        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.File file)
        -
        Decodes a key pair that was encoded by the store method.
        -
        -
        Parameters:
        -
        file - File containing the serialized keys.
        -
        Throws:
        -
        DSException - Wrapping underlying IOExceptions.
        -
        -
        • -
      - - - -
        -
      • -

        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 - Wrapping underlying IOExceptions.
        -
        -
        • -
      - - - -
        -
      • -

        store

        -
        public void store(java.io.File file)
        -
        Write the bytes from the string encoding to the given file.
        -
        -
        Parameters:
        -
        file - Will be created or overwritten.
        -
        Throws:
        -
        DSException - Wrapping underlying IOExceptions.
        -
        -
        • -
      - - - -
        -
      • -

        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 - Wrapping underlying IOExceptions.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/DSPasswordAes.html b/docs/javadoc/org/iot/dsa/security/DSPasswordAes.html deleted file mode 100644 index 5f14efcb..00000000 --- a/docs/javadoc/org/iot/dsa/security/DSPasswordAes.html +++ /dev/null @@ -1,615 +0,0 @@ - - - - - -DSPasswordAes (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.security
-

Class DSPasswordAes

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSPasswordAesNULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Stringdecode() -
      Returns the decrypted password.
      -
      static java.lang.Stringencode(byte[] arg) -
      Encrypts the given bytes.
      -
      static java.lang.Stringencode(java.lang.String arg) -
      Encrypts the given text.
      -
      booleanequals(java.lang.Object obj) 
      DSValueTypegetValueType() -
      The DSA type mapping.
      -
      inthashCode() 
      booleanisEqual(java.lang.Object obj) -
      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(java.lang.String clearText) -
      Encrypts the given string and compares against the value stored in this object.
      -
      DSPasswordAesrestore(DSElement element) -
      Deserialize a value from the configuration database, these will be values returned from the - store() method.
      -
      DSStringstore() -
      Serialize the value for the configuration database.
      -
      DSStringtoElement() -
      Returns a string representing the url safe base64 encoding of the hash.
      -
      java.lang.StringtoString() -
      If isNull(), returns "null", otherwise returns toElement().toString()
      -
      DSPasswordAesvalueOf(DSElement arg) -
      Creates a encrypted password for the given clear text.
      -
      static DSPasswordAesvalueOf(java.lang.String arg) -
      Creates a encrypted password for the given clear text.
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      - -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        decode

        -
        public java.lang.String decode()
        -
        Returns the decrypted password.
        -
        -
        Throws:
        -
        DSException - If there is a problem.
        -
        -
        • -
      - - - -
        -
      • -

        encode

        -
        public static java.lang.String encode(byte[] arg)
        -
        Encrypts the given bytes.
        -
        • -
      - - - -
        -
      • -

        encode

        -
        public static java.lang.String encode(java.lang.String arg)
        -
        Encrypts the given text.
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object obj)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        isValid

        -
        public boolean isValid(DSElement clearText)
        -
        Encrypts the string value of the given element and compares against the value stored in this - object.
        -
        -
        Specified by:
        -
        isValid in interface DSIPassword
        -
        Parameters:
        -
        clearText - If null, isNull, or is the empty string, this will on return true if this is - the NULL instance.
        -
        -
        • -
      - - - -
        -
      • -

        isValid

        -
        public boolean isValid(java.lang.String clearText)
        -
        Encrypts the given string and compares against the value stored in this object.
        -
        -
        Parameters:
        -
        clearText - If null, isNull, or is the empty string, this will on return true if this is - the NULL instance.
        -
        -
        • -
      - - - -
        -
      • -

        store

        -
        public DSString store()
        -
        Description copied from interface: DSIStorable
        -
        Serialize the value for the configuration database. Can be a different element type than - toElement().
        -
        -
        Specified by:
        -
        store in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public DSPasswordAes restore(DSElement element)
        -
        Description copied from interface: DSIStorable
        -
        Deserialize a value from the configuration database, these will be values returned from the - store() method.
        -
        -
        Specified by:
        -
        restore in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        toElement

        -
        public DSString toElement()
        -
        Returns a string representing the url safe base64 encoding of the hash.
        -
        -
        Specified by:
        -
        toElement in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public DSPasswordAes valueOf(DSElement arg)
        -
        Creates a encrypted password for the given clear text.
        -
        -
        Specified by:
        -
        valueOf in interface DSIValue
        -
        Parameters:
        -
        arg - The text to hash.
        -
        Returns:
        -
        Returns the NULL instance if the arg is null, isNull() or the empty string.
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSPasswordAes valueOf(java.lang.String arg)
        -
        Creates a encrypted password for the given clear text.
        -
        -
        Parameters:
        -
        arg - The text to hash.
        -
        Returns:
        -
        Returns the NULL instance if the arg is null or the empty string.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/DSPasswordSha256.html b/docs/javadoc/org/iot/dsa/security/DSPasswordSha256.html deleted file mode 100644 index 3044f0b6..00000000 --- a/docs/javadoc/org/iot/dsa/security/DSPasswordSha256.html +++ /dev/null @@ -1,595 +0,0 @@ - - - - - -DSPasswordSha256 (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.security
-

Class DSPasswordSha256

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSPasswordSha256NULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.lang.Stringencode(byte[] arg) -
      SHA-256 hash of the bytes encoded as url safe base 64..
      -
      static java.lang.Stringencode(java.lang.String arg) -
      SHA-256 hash of the UTF-8 bytes, encoded as url safe base 64..
      -
      booleanequals(java.lang.Object obj) 
      DSValueTypegetValueType() -
      The DSA type mapping.
      -
      inthashCode() 
      booleanisEqual(java.lang.Object obj) -
      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(java.lang.String clearText) -
      Hashes the given string and compares against the value stored in this object.
      -
      DSPasswordSha256restore(DSElement element) -
      Deserialize a value from the configuration database, these will be values returned from the - store() method.
      -
      DSStringstore() -
      Serialize the value for the configuration database.
      -
      DSStringtoElement() -
      Returns a string representing the url safe base64 encoding of the hash.
      -
      java.lang.StringtoString() -
      If isNull(), returns "null", otherwise returns toElement().toString()
      -
      DSPasswordSha256valueOf(DSElement arg) -
      Creates a digest password for the given clear text.
      -
      static DSPasswordSha256valueOf(java.lang.String arg) -
      Creates a digest password for the given clear text.
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      - -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        encode

        -
        public static java.lang.String encode(byte[] arg)
        -
        SHA-256 hash of the bytes encoded as url safe base 64..
        -
        • -
      - - - -
        -
      • -

        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..
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object obj)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - - - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Description copied from interface: DSIObject
        -
        Equals implementation that doesn't require hashCodes to equal, primarily intended - so for comparing nodes.
        -
        -
        Specified by:
        -
        isEqual in interface DSIObject
        -
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        -
        Specified by:
        -
        isNull in interface DSIObject
        -
        Specified by:
        -
        isNull in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        isValid

        -
        public boolean isValid(DSElement clearText)
        -
        Hashes the string value of the given element and compares against the hash stored in this - object.
        -
        -
        Specified by:
        -
        isValid in interface DSIPassword
        -
        Parameters:
        -
        clearText - If null, isNull, or is the empty string, this will on return true if this is - the NULL instance.
        -
        -
        • -
      - - - -
        -
      • -

        isValid

        -
        public boolean isValid(java.lang.String clearText)
        -
        Hashes the given string and compares against the value stored in this object.
        -
        -
        Parameters:
        -
        clearText - If null, or the empty string, this will on return true if this is the NULL - instance.
        -
        -
        • -
      - - - -
        -
      • -

        store

        -
        public DSString store()
        -
        Description copied from interface: DSIStorable
        -
        Serialize the value for the configuration database. Can be a different element type than - toElement().
        -
        -
        Specified by:
        -
        store in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public DSPasswordSha256 restore(DSElement element)
        -
        Description copied from interface: DSIStorable
        -
        Deserialize a value from the configuration database, these will be values returned from the - store() method.
        -
        -
        Specified by:
        -
        restore in interface DSIStorable
        -
        -
        • -
      - - - -
        -
      • -

        toElement

        -
        public DSString toElement()
        -
        Returns a string representing the url safe base64 encoding of the hash.
        -
        -
        Specified by:
        -
        toElement in interface DSIValue
        -
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Description copied from class: DSValue
        -
        If isNull(), returns "null", otherwise returns toElement().toString()
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public DSPasswordSha256 valueOf(DSElement arg)
        -
        Creates a digest password for the given clear text.
        -
        -
        Specified by:
        -
        valueOf in interface DSIValue
        -
        Parameters:
        -
        arg - The text to hash.
        -
        Returns:
        -
        Returns the NULL instance if the arg is null, isNull() or the empty string.
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSPasswordSha256 valueOf(java.lang.String arg)
        -
        Creates a digest password for the given clear text.
        -
        -
        Parameters:
        -
        arg - The text to hash.
        -
        Returns:
        -
        Returns the NULL instance if the arg is null or the empty string.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/DSPermission.html b/docs/javadoc/org/iot/dsa/security/DSPermission.html deleted file mode 100644 index bc64e268..00000000 --- a/docs/javadoc/org/iot/dsa/security/DSPermission.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - -DSPermission (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.security
-

Enum DSPermission

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<DSPermission>
    -
    -
    -
    -
    public enum DSPermission
-extends java.lang.Enum<DSPermission>
    -
    Used to define the required permissions for various objects.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum Constant and Description
      CONFIG 
      LIST 
      READ 
      WRITE 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSPermissionforString(java.lang.String str) 
      intgetLevel() 
      booleanisConfig() 
      booleanisGreaterThan(DSPermission arg) -
      True if this level is higher than the given.
      -
      booleanisList() 
      booleanisRead() 
      booleanisWrite() 
      java.lang.StringtoString() 
      static DSPermissionvalueOf(int v2byte) 
      static DSPermissionvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static DSPermission[]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, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static DSPermission[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DSPermission c : DSPermission.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      - - - -
        -
      • -

        getLevel

        -
        public int getLevel()
        -
        • -
      - - - -
        -
      • -

        isConfig

        -
        public boolean isConfig()
        -
        • -
      - - - -
        -
      • -

        isGreaterThan

        -
        public boolean isGreaterThan(DSPermission arg)
        -
        True if this level is higher than the given.
        -
        • -
      - - - -
        -
      • -

        isRead

        -
        public boolean isRead()
        -
        • -
      - - - -
        -
      • -

        isWrite

        -
        public boolean isWrite()
        -
        • -
      - - - -
        -
      • -

        isList

        -
        public boolean isList()
        -
        • -
      - - - -
        -
      • -

        forString

        -
        public static DSPermission forString(java.lang.String str)
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Enum<DSPermission>
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSPermission valueOf(int v2byte)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/package-frame.html b/docs/javadoc/org/iot/dsa/security/package-frame.html deleted file mode 100644 index d21f80b2..00000000 --- a/docs/javadoc/org/iot/dsa/security/package-frame.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - -org.iot.dsa.security (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.security

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/docs/javadoc/org/iot/dsa/security/package-summary.html b/docs/javadoc/org/iot/dsa/security/package-summary.html deleted file mode 100644 index ab2a29aa..00000000 --- a/docs/javadoc/org/iot/dsa/security/package-summary.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - -org.iot.dsa.security (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.security

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/security/package-tree.html b/docs/javadoc/org/iot/dsa/security/package-tree.html deleted file mode 100644 index 50d9d8f3..00000000 --- a/docs/javadoc/org/iot/dsa/security/package-tree.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - -org.iot.dsa.security Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.security

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/time/DSDateTime.html b/docs/javadoc/org/iot/dsa/time/DSDateTime.html deleted file mode 100644 index d08141b7..00000000 --- a/docs/javadoc/org/iot/dsa/time/DSDateTime.html +++ /dev/null @@ -1,478 +0,0 @@ - - - - - -DSDateTime (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.time
-

Class DSDateTime

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    DSIObject, DSIValue
    -
    -
    -
    -
    public class DSDateTime
-extends DSValue
    -
    Wrapper for Java time.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static DSDateTimeNULL 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static DSDateTimecurrentTime() -
      The current time.
      -
      booleanequals(java.lang.Object obj) 
      DSValueTypegetValueType() -
      String.
      -
      inthashCode() 
      booleanisEqual(java.lang.Object obj) -
      Defaults to the equals method.
      -
      booleanisNull() -
      Values should have an instance representing null.
      -
      longtimeInMillis() -
      The Java time represented by this object.
      -
      DSElementtoElement() -
      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".
      -
      DSDateTimevalueOf(DSElement element) -
      This should convert an element transmitted over DSA, such as subscription updates or set - requests.
      -
      static DSDateTimevalueOf(long millis) 
      static DSDateTimevalueOf(java.lang.String string) -
      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
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        currentTime

        -
        public static DSDateTime currentTime()
        -
        The current time.
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object obj)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        getValueType

        -
        public DSValueType getValueType()
        -
        String.
        -
        • -
      - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        isEqual

        -
        public boolean isEqual(java.lang.Object obj)
        -
        Defaults to the equals method.
        -
        • -
      - - - -
        -
      • -

        isNull

        -
        public boolean isNull()
        -
        Description copied from interface: DSIValue
        -
        Values should have an instance representing null. This will allow null defaults in nodes, - but the null instance can be used to properly decode incoming values such as set requests.
        -
        • -
      - - - -
        -
      • -

        timeInMillis

        -
        public long timeInMillis()
        -
        The Java time represented by this 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.
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
        -
        -
        Overrides:
        -
        toString in class DSValue
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSDateTime valueOf(long millis)
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DSDateTime valueOf(java.lang.String string)
        -
        Decodes an ISO 8601 standard format of "yyyy-mm-ddThh:mm:ss.mmm[+/-]hh:mm".
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/time/DSInterval.html b/docs/javadoc/org/iot/dsa/time/DSInterval.html deleted file mode 100644 index 94070d76..00000000 --- a/docs/javadoc/org/iot/dsa/time/DSInterval.html +++ /dev/null @@ -1,642 +0,0 @@ - - - - - -DSInterval (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
org.iot.dsa.time
-

Enum DSInterval

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<DSInterval>
    -
    -
    -
    -
    public enum DSInterval
-extends java.lang.Enum<DSInterval>
    -
    Enum representing periods of time.
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static DSInterval[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DSInterval c : DSInterval.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        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 name
        -
        java.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.
        -
        • -
      - - - -
        -
      • -

        millis

        -
        public long millis()
        -
        The approximate number of ms in the interval.
        -
        • -
      - - - -
        -
      • -

        next

        -
        public long next(long timestamp)
        -
        Returns the nextRun interval for the previously aligned timestamp.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/time/DSTime.html b/docs/javadoc/org/iot/dsa/time/DSTime.html deleted file mode 100644 index 50c646b0..00000000 --- a/docs/javadoc/org/iot/dsa/time/DSTime.html +++ /dev/null @@ -1,1514 +0,0 @@ - - - - - -DSTime (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.time
-

Class DSTime

-
-
- -
-
    -
  • -
    -
    -
    public class DSTime
-extends java.lang.Object
    -
    Misc time utility functions.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.util.CalendaraddDays(int count, - java.util.Calendar timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static longaddDays(int count, - long timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static java.util.CalendaraddHours(int count, - java.util.Calendar timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static longaddHours(int count, - long timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static java.util.CalendaraddMinutes(int count, - java.util.Calendar timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static longaddMinutes(int count, - long timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static java.util.CalendaraddMonths(int count, - java.util.Calendar timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static longaddMonths(int count, - long timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static java.util.CalendaraddSeconds(int count, - java.util.Calendar timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static longaddSeconds(int count, - long timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static java.util.CalendaraddWeeks(int count, - java.util.Calendar timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static longaddWeeks(int count, - long timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static java.util.CalendaraddYears(int count, - java.util.Calendar timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static longaddYears(int count, - long timestamp) -
      Adds or subtracts the corresponding time field, does not perform any alignment.
      -
      static java.util.CalendaralignDay(java.util.Calendar timestamp) -
      Aligns the time fields to the start of the day.
      -
      static java.util.CalendaralignDays(int interval, - java.util.Calendar timestamp) -
      Aligns the time fields to the start of given interval.
      -
      static java.util.CalendaralignHour(java.util.Calendar timestamp) -
      Aligns the time fields to the start of the hour.
      -
      static java.util.CalendaralignHours(int interval, - java.util.Calendar timestamp) -
      Aligns the time fields to the start of given interval.
      -
      static java.util.CalendaralignMinute(java.util.Calendar timestamp) -
      Aligns the time fields to the start of the minute.
      -
      static java.util.CalendaralignMinutes(int interval, - java.util.Calendar timestamp) -
      Aligns the time fields to the start of given interval.
      -
      static java.util.CalendaralignMonth(java.util.Calendar timestamp) -
      Aligns the time fields to the start of the month.
      -
      static java.util.CalendaralignSecond(java.util.Calendar timestamp) -
      Aligns the time fields to the start of the second.
      -
      static java.util.CalendaralignSeconds(int interval, - java.util.Calendar timestamp) -
      Aligns the time fields to the start of given interval.
      -
      static java.util.CalendaralignWeek(java.util.Calendar timestamp) -
      Aligns the time fields to the start of the week.
      -
      static java.util.CalendaralignYear(java.util.Calendar timestamp) -
      Aligns the time fields to the start of the year.
      -
      static longdecode(java.lang.String timestamp) -
      This is a convenience that uses reuses and recycles a calendar instance to get the time in - millis.
      -
      static java.util.Calendardecode(java.lang.String timestamp, - java.util.Calendar calendar) -
      Converts a DSA encoded timestamp into a Java Calendar.
      -
      static java.lang.StringBuilderencode(java.util.Calendar calendar, - boolean encodeTzOffset, - java.lang.StringBuilder buf) -
      Converts a Java Calendar into a DSA encoded timestamp.
      -
      static java.lang.StringBuilderencode(long timestamp, - boolean encodeTzOffset) -
      Converts a Java Calendar into a DSA encoded timestamp.
      -
      static java.lang.StringBuilderencode(long timestamp, - boolean encodeTzOffset, - java.lang.StringBuilder buf) -
      Converts a Java Calendar into a DSA encoded timestamp.
      -
      static java.lang.StringBuilderencodeForFiles(java.util.Calendar calendar, - java.lang.StringBuilder buf) -
      Converts a Java Calendar into a number safe for file names: YYMMDDHHMMSS.
      -
      static java.lang.StringBuilderencodeForLogs(java.util.Calendar calendar, - java.lang.StringBuilder buf) -
      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(long timestamp) -
      Attempts to reuse a calendar instance and sets the time in millis to the argument and the - timezone to TimeZone.getDefault().
      -
      static longmillisToNanos(long millis) 
      static longnanosToMillis(long nanos) 
      static voidrecycle(java.util.Calendar cal) -
      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.
        -
        -
        • -
      - - - -
        -
      • -

        alignDay

        -
        public static java.util.Calendar alignDay(java.util.Calendar timestamp)
        -
        Aligns the time fields to the start of the day.
        -
        -
        Parameters:
        -
        timestamp - The calendar to align.
        -
        Returns:
        -
        The parameter.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        alignHour

        -
        public static java.util.Calendar alignHour(java.util.Calendar timestamp)
        -
        Aligns the time fields to the start of the hour.
        -
        -
        Parameters:
        -
        timestamp - The calendar to align.
        -
        Returns:
        -
        The parameter.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        alignMinute

        -
        public static java.util.Calendar alignMinute(java.util.Calendar timestamp)
        -
        Aligns the time fields to the start of the minute.
        -
        -
        Parameters:
        -
        timestamp - The calendar to align.
        -
        Returns:
        -
        The parameter.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        alignMonth

        -
        public static java.util.Calendar alignMonth(java.util.Calendar timestamp)
        -
        Aligns the time fields to the start of the month.
        -
        -
        Parameters:
        -
        timestamp - The calendar to align.
        -
        Returns:
        -
        The parameter.
        -
        -
        • -
      - - - -
        -
      • -

        alignSecond

        -
        public static java.util.Calendar alignSecond(java.util.Calendar timestamp)
        -
        Aligns the time fields to the start of the second.
        -
        -
        Parameters:
        -
        timestamp - The calendar to align.
        -
        Returns:
        -
        The parameter.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        • -
      - - - -
        -
      • -

        alignWeek

        -
        public static java.util.Calendar alignWeek(java.util.Calendar timestamp)
        -
        Aligns the time fields to the start of the week.
        -
        -
        Parameters:
        -
        timestamp - The calendar to align.
        -
        Returns:
        -
        The parameter.
        -
        -
        • -
      - - - -
        -
      • -

        alignYear

        -
        public static java.util.Calendar alignYear(java.util.Calendar timestamp)
        -
        Aligns the time fields to the start of the year.
        -
        -
        Parameters:
        -
        timestamp - The calendar to align.
        -
        Returns:
        -
        The parameter.
        -
        -
        • -
      - - - -
        -
      • -

        decode

        -
        public static long decode(java.lang.String timestamp)
        -
        This is a convenience that uses reuses and recycles a calendar instance to get the time in - millis.
        -
        • -
      - - - -
        -
      • -

        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().
        -
        • -
      - - - -
        -
      • -

        getCalendar

        -
        public static java.util.Calendar getCalendar(long timestamp)
        -
        Attempts to reuse a calendar instance and sets the time in millis to the argument and the - timezone to TimeZone.getDefault().
        -
        • -
      - - - -
        -
      • -

        millisToNanos

        -
        public static long millisToNanos(long millis)
        -
        • -
      - - - -
        -
      • -

        nanosToMillis

        -
        public static long nanosToMillis(long nanos)
        -
        • -
      - - - -
        -
      • -

        recycle

        -
        public static void recycle(java.util.Calendar cal)
        -
        Return a calendar instance for reuse.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/time/package-frame.html b/docs/javadoc/org/iot/dsa/time/package-frame.html deleted file mode 100644 index d4105272..00000000 --- a/docs/javadoc/org/iot/dsa/time/package-frame.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - -org.iot.dsa.time (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.time

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/javadoc/org/iot/dsa/time/package-summary.html b/docs/javadoc/org/iot/dsa/time/package-summary.html deleted file mode 100644 index 0a466aa0..00000000 --- a/docs/javadoc/org/iot/dsa/time/package-summary.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - -org.iot.dsa.time (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.time

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/time/package-tree.html b/docs/javadoc/org/iot/dsa/time/package-tree.html deleted file mode 100644 index 275e5402..00000000 --- a/docs/javadoc/org/iot/dsa/time/package-tree.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - -org.iot.dsa.time Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.time

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/util/DSException.html b/docs/javadoc/org/iot/dsa/util/DSException.html deleted file mode 100644 index cb124a30..00000000 --- a/docs/javadoc/org/iot/dsa/util/DSException.html +++ /dev/null @@ -1,494 +0,0 @@ - - - - - -DSException (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
org.iot.dsa.util
-

Class DSException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class DSException
-extends java.lang.RuntimeException
    -
    An runtime exception that forwards most calls to the inner exception. This is to exclude itself - from reporting and expose the real issue as soon as possible.

    The throwRuntime method is a - convenience for converting checked exceptions into runtime exceptions.

    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DSException(java.lang.Throwable inner) 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.ThrowablegetCause() 
      java.lang.StringgetLocalizedMessage() 
      java.lang.StringgetMessage() 
      java.lang.StackTraceElement[]getStackTrace() 
      java.lang.ThrowableinitCause(java.lang.Throwable cause) 
      static java.lang.StringmakeMessage(java.lang.Throwable t) -
      Attempts come up with the best description of the argument.
      -
      static java.lang.RuntimeExceptionmakeRuntime(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.
      -
      voidprintStackTrace() 
      voidprintStackTrace(java.io.PrintStream out) 
      voidprintStackTrace(java.io.PrintWriter out) 
      static voidthrowRuntime(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.
      -
      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

      - - - -
        -
      • -

        DSException

        -
        public DSException(java.lang.Throwable inner)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getCause

        -
        public java.lang.Throwable getCause()
        -
        -
        Overrides:
        -
        getCause in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        getMessage

        -
        public java.lang.String getMessage()
        -
        -
        Overrides:
        -
        getMessage in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        getLocalizedMessage

        -
        public java.lang.String getLocalizedMessage()
        -
        -
        Overrides:
        -
        getLocalizedMessage in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        getStackTrace

        -
        public java.lang.StackTraceElement[] getStackTrace()
        -
        -
        Overrides:
        -
        getStackTrace in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        makeMessage

        -
        public static java.lang.String makeMessage(java.lang.Throwable t)
        -
        Attempts come up with the best description of the argument.
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        printStackTrace

        -
        public void printStackTrace()
        -
        -
        Overrides:
        -
        printStackTrace in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        printStackTrace

        -
        public void printStackTrace(java.io.PrintStream out)
        -
        -
        Overrides:
        -
        printStackTrace in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        printStackTrace

        -
        public void printStackTrace(java.io.PrintWriter out)
        -
        -
        Overrides:
        -
        printStackTrace in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        initCause

        -
        public java.lang.Throwable initCause(java.lang.Throwable cause)
        -
        -
        Overrides:
        -
        initCause in class java.lang.Throwable
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Throwable
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/util/DSUtil.html b/docs/javadoc/org/iot/dsa/util/DSUtil.html deleted file mode 100644 index 4c53e748..00000000 --- a/docs/javadoc/org/iot/dsa/util/DSUtil.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - -DSUtil (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
org.iot.dsa.util
-

Class DSUtil

-
-
- -
-
    -
  • -
    -
    -
    public class DSUtil
-extends java.lang.Object
    -
    Common utilities.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static booleanequal(java.lang.Object o1, - java.lang.Object o2) -
      Comparison that takes null into account; null == null.
      -
      static booleangetBit(int bits, - int index) -
      Returns true if the bit at the given index is set.
      -
      static intsetBit(int bits, - int index, - boolean set) -
      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.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/util/package-frame.html b/docs/javadoc/org/iot/dsa/util/package-frame.html deleted file mode 100644 index dd36b36c..00000000 --- a/docs/javadoc/org/iot/dsa/util/package-frame.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - -org.iot.dsa.util (dslink-core 0.20.0 API) - - - - - -

org.iot.dsa.util

-
-

Classes

- -

Exceptions

- -
- - diff --git a/docs/javadoc/org/iot/dsa/util/package-summary.html b/docs/javadoc/org/iot/dsa/util/package-summary.html deleted file mode 100644 index c39f43eb..00000000 --- a/docs/javadoc/org/iot/dsa/util/package-summary.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - -org.iot.dsa.util (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package org.iot.dsa.util

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/org/iot/dsa/util/package-tree.html b/docs/javadoc/org/iot/dsa/util/package-tree.html deleted file mode 100644 index f7f54c2a..00000000 --- a/docs/javadoc/org/iot/dsa/util/package-tree.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - -org.iot.dsa.util Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package org.iot.dsa.util

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/overview-frame.html b/docs/javadoc/overview-frame.html deleted file mode 100644 index a5f047ed..00000000 --- a/docs/javadoc/overview-frame.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - -Overview List (dslink-core 0.20.0 API) - - - - - -
All Classes
-
-

Packages

- -
-

 

- - diff --git a/docs/javadoc/overview-summary.html b/docs/javadoc/overview-summary.html deleted file mode 100644 index 3816eb13..00000000 --- a/docs/javadoc/overview-summary.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - -Overview (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

dslink-core 0.20.0 API

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Packages 
PackageDescription
org.iot.dsa -
Use the DSRuntime thread pool and timers.
-
org.iot.dsa.dslink -
DSLink is the main entry point for an application.
-
org.iot.dsa.dslink.requester -
API for implementing requesters without having to modeling everything in the node tree.
-
org.iot.dsa.dslink.responder -
API for implementing responders without having modeling everything in the node tree.
-
org.iot.dsa.io -
Node serialization and streaming abstraction for JSON and MsgPack.
-
org.iot.dsa.io.json 
org.iot.dsa.logging -
Async handler for Java Util Logging that also manages log backups.
-
org.iot.dsa.node -
Persistent data model used to build the node tree of a link.
-
org.iot.dsa.node.action 
org.iot.dsa.node.event 
org.iot.dsa.security 
org.iot.dsa.time 
org.iot.dsa.util 
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/overview-tree.html b/docs/javadoc/overview-tree.html deleted file mode 100644 index dd3937f3..00000000 --- a/docs/javadoc/overview-tree.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - -Class Hierarchy (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For All Packages

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/docs/javadoc/package-list b/docs/javadoc/package-list deleted file mode 100644 index 45c7b2dc..00000000 --- a/docs/javadoc/package-list +++ /dev/null @@ -1,13 +0,0 @@ -org.iot.dsa -org.iot.dsa.dslink -org.iot.dsa.dslink.requester -org.iot.dsa.dslink.responder -org.iot.dsa.io -org.iot.dsa.io.json -org.iot.dsa.logging -org.iot.dsa.node -org.iot.dsa.node.action -org.iot.dsa.node.event -org.iot.dsa.security -org.iot.dsa.time -org.iot.dsa.util diff --git a/docs/javadoc/script.js b/docs/javadoc/script.js deleted file mode 100644 index b3463569..00000000 --- a/docs/javadoc/script.js +++ /dev/null @@ -1,30 +0,0 @@ -function show(type) -{ - count = 0; - for (var key in methods) { - var row = document.getElementById(key); - if ((methods[key] & type) != 0) { - row.style.display = ''; - row.className = (count++ % 2) ? rowColor : altColor; - } - else - row.style.display = 'none'; - } - updateTabs(type); -} - -function updateTabs(type) -{ - for (var value in tabs) { - var sNode = document.getElementById(tabs[value][0]); - var spanNode = sNode.firstChild; - if (value == type) { - sNode.className = activeTableTab; - spanNode.innerHTML = tabs[value][1]; - } - else { - sNode.className = tableTab; - spanNode.innerHTML = "" + tabs[value][1] + ""; - } - } -} diff --git a/docs/javadoc/serialized-form.html b/docs/javadoc/serialized-form.html deleted file mode 100644 index d693c8b4..00000000 --- a/docs/javadoc/serialized-form.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - -Serialized Form (dslink-core 0.20.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Serialized Form

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - 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; -}