From a81d98f692b80c45bce3fe6a87e731abfb012a9f Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Thu, 24 Nov 2016 23:56:18 +0100 Subject: [PATCH] Fix javadocs and enable doclint This eliminates the doclint suppression and fixes up javadoc, so they work with Java 8 out of the box. Change-Id: I7294f0dcd570e3e3c445e54cc8989078175d05d7 Signed-off-by: Robert Varga --- opendaylight/commons/liblldp/pom.xml | 22 ------ .../controller/liblldp/BitBufferHelper.java | 76 +++++-------------- .../controller/liblldp/DataLinkAddress.java | 2 - .../controller/liblldp/Ethernet.java | 6 +- .../controller/liblldp/EthernetAddress.java | 2 - .../opendaylight/controller/liblldp/LLDP.java | 19 +++-- .../controller/liblldp/LLDPTLV.java | 12 +-- .../controller/liblldp/Packet.java | 16 ++-- .../commons/protocol-framework/pom.xml | 21 ----- .../framework/AbstractDispatcher.java | 4 +- .../framework/AbstractSessionNegotiator.java | 2 +- .../protocol/framework/SessionListener.java | 2 +- .../framework/TimedReconnectStrategy.java | 2 +- opendaylight/config/config-api/pom.xml | 22 ------ .../controller/config/api/ConfigRegistry.java | 7 +- .../RuntimeBeanRegistratorAwareModule.java | 2 +- .../api/ServiceReferenceWritableRegistry.java | 1 - .../api/annotations/RequireInterface.java | 9 +-- .../ConfigTransactionControllerMXBean.java | 2 +- .../notifications/ConfigJMXNotification.java | 3 - .../controller/config/spi/AbstractModule.java | 2 +- .../controller/config/spi/ModuleFactory.java | 10 +-- .../facade/xml/ConfigSubsystemFacade.java | 2 +- .../ArrayAttributeReadingStrategy.java | 4 - .../facade/xml/mapping/config/Config.java | 2 +- .../dynamicmbean/DynamicWritableWrapper.java | 2 +- .../ModuleFactoriesResolver.java | 2 +- .../impl/jmx/ModuleJMXRegistrator.java | 2 +- .../impl/osgi/ExtensibleBundleTracker.java | 2 +- opendaylight/config/pom.xml | 18 ----- .../yangjmxgenerator/ModuleMXBeanEntry.java | 1 - .../yangjmxgenerator/PackageTranslator.java | 5 +- .../ServiceInterfaceEntry.java | 1 - .../attribute/AbstractAttribute.java | 2 +- opendaylight/md-sal/messagebus-spi/pom.xml | 21 ----- .../messagebus/spi/EventSource.java | 4 +- .../messagebus/spi/EventSourceRegistry.java | 9 +-- .../controller/messagebus/app/util/Util.java | 2 +- opendaylight/md-sal/pom.xml | 18 ----- .../example/ExampleRoleChangeListener.java | 6 +- .../controller/cluster/raft/ConfigParams.java | 6 +- .../cluster/raft/DefaultConfigParamsImpl.java | 3 +- .../controller/cluster/raft/ElectionTerm.java | 6 +- .../controller/cluster/raft/RaftActor.java | 20 ++--- .../RaftActorLeadershipTransferCohort.java | 10 ++- .../cluster/raft/ReplicatedLog.java | 3 +- .../raft/behaviors/AbstractLeader.java | 8 +- .../cluster/raft/behaviors/Candidate.java | 3 +- .../cluster/raft/behaviors/Follower.java | 1 - .../raft/behaviors/IsolatedLeader.java | 10 ++- .../cluster/raft/behaviors/Leader.java | 11 +-- .../cluster/raft/behaviors/PreLeader.java | 3 +- .../raft/client/messages/FindLeader.java | 3 +- .../raft/client/messages/FindLeaderReply.java | 3 +- .../cluster/raft/policy/RaftPolicy.java | 4 +- opendaylight/md-sal/sal-binding-api/pom.xml | 22 ------ .../api/ClusteredDataChangeListener.java | 4 +- .../binding/api/DataObjectModification.java | 2 - .../binding/api/DataTreeChangeService.java | 4 +- .../sal/binding/api/DataTreeIdentifier.java | 4 +- .../api/NotificationPublishService.java | 4 +- .../sal/binding/api/NotificationService.java | 14 ++-- .../api/AbstractBrokerAwareActivator.java | 6 +- .../sal/binding/api/BindingAwareBroker.java | 16 ++-- .../sal/binding/api/BindingAwareConsumer.java | 3 - .../sal/binding/api/BindingAwareProvider.java | 16 ++-- .../sal/binding/api/NotificationService.java | 19 ++--- .../sal/binding/api/RpcConsumerRegistry.java | 6 +- .../sal/binding/api/RpcProviderRegistry.java | 12 +-- .../binding/api/data/DataBrokerService.java | 6 +- .../api/data/DataModificationTransaction.java | 20 ++--- .../api/data/SynchronizedTransaction.java | 6 +- .../cluster/common/actor/MessageTracker.java | 2 +- .../common/actor/MeteringBehavior.java | 9 ++- .../cluster/common/actor/UnifiedConfig.java | 3 +- .../notifications/RoleChangeNotifier.java | 3 +- .../protobuff/client/messages/Payload.java | 3 +- .../cluster/reporting/MetricsReporter.java | 3 +- .../md/sal/common/api/clustering/Entity.java | 10 +-- .../data/AsyncConfigurationCommitHandler.java | 1 + .../sal/common/api/data/AsyncDataBroker.java | 3 +- .../api/data/AsyncDataChangeListener.java | 2 + .../common/api/data/AsyncReadTransaction.java | 3 - .../api/data/AsyncWriteTransaction.java | 14 ++-- .../sal/common/api/data/DataModification.java | 5 -- .../sal/common/api/data/TransactionChain.java | 2 +- .../jmx/QueuedNotificationManagerMXBean.java | 2 +- .../cluster/datastore/DataChangeListener.java | 2 +- .../controller/cluster/datastore/Shard.java | 3 +- .../cluster/datastore/ShardDataTree.java | 3 +- .../cluster/datastore/TransactionContext.java | 3 +- .../TransactionReadyReplyMapper.java | 3 +- .../datastore/messages/DataTreeChanged.java | 4 +- .../datastore/messages/FindLocalShard.java | 4 +- .../datastore/messages/LocalShardFound.java | 4 +- .../messages/LocalShardNotFound.java | 4 +- .../datastore/modification/Modification.java | 5 +- .../datastore/persisted/PayloadVersion.java | 9 ++- .../ShardDataTreeSnapshotMetadata.java | 6 +- .../shardstrategy/ShardStrategy.java | 3 +- .../md/sal/dom/api/DOMDataTreeListener.java | 2 +- .../md/sal/dom/api/DOMDataTreeProducer.java | 12 +-- .../dom/api/DOMDataTreeProducerFactory.java | 2 +- .../md/sal/dom/api/DOMDataTreeService.java | 2 +- .../sal/dom/api/DOMDataWriteTransaction.java | 3 + .../md/sal/dom/api/DOMExtensibleService.java | 4 +- .../api/DOMNotificationPublishService.java | 7 +- .../api/DOMNotificationRejectedException.java | 3 +- .../sal/dom/api/DOMNotificationService.java | 4 +- .../md/sal/dom/api/DOMRpcService.java | 4 +- .../controller/sal/core/api/Consumer.java | 2 +- .../controller/sal/core/api/Provider.java | 2 +- ...bstractDOMForwardedTransactionFactory.java | 47 ++++++------ .../spi/data/AbstractDOMStoreTransaction.java | 2 +- .../data/DOMStoreThreePhaseCommitCohort.java | 3 +- .../spi/data/DOMStoreWriteTransaction.java | 6 +- .../data/SnapshotBackedReadTransaction.java | 2 +- .../data/SnapshotBackedWriteTransaction.java | 5 +- .../md-sal/sal-remoterpc-connector/pom.xml | 21 ----- .../remote/rpc/registry/RpcRegistry.java | 3 +- .../remote/rpc/registry/gossip/Gossiper.java | 10 ++- pom.xml | 22 ------ 122 files changed, 328 insertions(+), 563 deletions(-) diff --git a/opendaylight/commons/liblldp/pom.xml b/opendaylight/commons/liblldp/pom.xml index edfc55397a..62a21f23e4 100644 --- a/opendaylight/commons/liblldp/pom.xml +++ b/opendaylight/commons/liblldp/pom.xml @@ -54,28 +54,6 @@ - - - - jdk8 - - [1.8,) - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - - - scm:git:http://git.opendaylight.org/gerrit/controller.git scm:git:ssh://git.opendaylight.org:29418/controller.git diff --git a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/BitBufferHelper.java b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/BitBufferHelper.java index c1d2beff3e..fd0659990e 100644 --- a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/BitBufferHelper.java +++ b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/BitBufferHelper.java @@ -37,7 +37,6 @@ public abstract class BitBufferHelper { /** * Returns the first byte from the byte array - * @param byte[] data * @return byte value */ public static byte getByte(byte[] data) { @@ -55,7 +54,6 @@ public abstract class BitBufferHelper { /** * Returns the short value for the byte array passed. * Size of byte array is restricted to Short.SIZE - * @param byte[] data * @return short value */ public static short getShort(byte[] data) { @@ -73,7 +71,6 @@ public abstract class BitBufferHelper { /** * Returns the int value for the byte array passed. * Size of byte array is restricted to Integer.SIZE - * @param byte[] data * @return int - the integer value of byte array */ public static int getInt(byte[] data) { @@ -91,7 +88,6 @@ public abstract class BitBufferHelper { /** * Returns the long value for the byte array passed. * Size of byte array is restricted to Long.SIZE - * @param byte[] data * @return long - the integer value of byte array */ public static long getLong(byte[] data) { @@ -109,8 +105,6 @@ public abstract class BitBufferHelper { /** * Returns the short value for the last numBits of the byte array passed. * Size of numBits is restricted to Short.SIZE - * @param byte[] data - * @param int - numBits * @return short - the short value of byte array */ public static short getShort(byte[] data, int numBits) { @@ -135,8 +129,6 @@ public abstract class BitBufferHelper { /** * Returns the int value for the last numBits of the byte array passed. * Size of numBits is restricted to Integer.SIZE - * @param byte[] data - * @param int - numBits * @return int - the integer value of byte array */ public static int getInt(byte[] data, int numBits) { @@ -161,8 +153,6 @@ public abstract class BitBufferHelper { /** * Returns the long value for the last numBits of the byte array passed. * Size of numBits is restricted to Long.SIZE - * @param byte[] data - * @param int - numBits * @return long - the integer value of byte array */ public static long getLong(byte[] data, int numBits) { @@ -205,9 +195,8 @@ public abstract class BitBufferHelper { * 0101000010 | 0000101 | 1111001010010101011 * will be returned as {0,0,0,0,0,1,0,1} * - * @param byte[] data - * @param int startOffset - offset to start fetching bits from data from - * @param int numBits - number of bits to be fetched from data + * @param startOffset - offset to start fetching bits from data from + * @param numBits - number of bits to be fetched from data * @return byte [] - LSB aligned bits * * @throws BufferException @@ -286,10 +275,10 @@ public abstract class BitBufferHelper { /** * Bits are expected to be stored in the input byte array from LSB - * @param byte[] - data to set the input byte - * @param byte - input byte to be inserted - * @param startOffset - offset of data[] to start inserting byte from - * @param numBits - number of bits of input to be inserted into data[] + * @param data to set the input byte + * @param input byte to be inserted + * @param startOffset offset of data[] to start inserting byte from + * @param numBits number of bits of input to be inserted into data[] * * @throws BufferException * when the input, startOffset and numBits are not congruent @@ -304,11 +293,10 @@ public abstract class BitBufferHelper { /** * Bits are expected to be stored in the input byte array from LSB - * @param byte[] - data to set the input byte - * @param byte[] - input bytes to be inserted - * @param startOffset - offset of data[] to start inserting byte from - * @param numBits - number of bits of input to be inserted into data[] - * @return void + * @param data to set the input byte + * @param input bytes to be inserted + * @param startOffset offset of data[] to start inserting byte from + * @param numBits number of bits of input to be inserted into data[] * @throws BufferException * when the startOffset and numBits parameters are not congruent * with data and input buffers' size @@ -321,9 +309,6 @@ public abstract class BitBufferHelper { /** * Returns numBits 1's in the MSB position - * - * @param numBits - * @return */ public static int getMSBMask(int numBits) { int mask = 0; @@ -335,9 +320,6 @@ public abstract class BitBufferHelper { /** * Returns numBits 1's in the LSB position - * - * @param numBits - * @return */ public static int getLSBMask(int numBits) { int mask = 0; @@ -350,7 +332,6 @@ public abstract class BitBufferHelper { /** * Returns the numerical value of the byte array passed * - * @param byte[] - array * @return long - numerical value of byte array passed */ static public long toNumber(byte[] array) { @@ -372,8 +353,6 @@ public abstract class BitBufferHelper { * Returns the numerical value of the last numBits (LSB bits) of the byte * array passed * - * @param byte[] - array - * @param int - numBits * @return long - numerical value of byte array passed */ static public long toNumber(byte[] array, int numBits) { @@ -405,12 +384,7 @@ public abstract class BitBufferHelper { * Accepts a number as input and returns its value in byte form in LSB * aligned form example: input = 5000 [1001110001000] bytes = 19, -120 * [00010011] [10001000] - * - * @param Number - * @return byte[] - * */ - public static byte[] toByteArray(Number input) { Class dataType = input.getClass(); short size = 0; @@ -445,9 +419,7 @@ public abstract class BitBufferHelper { * aligned form example: input = 5000 [1001110001000] bytes = -114, 64 * [10011100] [01000000] * - * @param Number - * input - * @param int numBits - the number of bits to be returned + * @param numBits - the number of bits to be returned * @return byte[] * */ @@ -500,21 +472,15 @@ public abstract class BitBufferHelper { /** * Takes an LSB aligned byte array and returned the LSB numBits in a MSB - * aligned byte array - * - * @param inputbytes - * @param numBits - * @return - */ - /** + * aligned byte array. + *

* It aligns the last numBits bits to the head of the byte array following * them with numBits % 8 zero bits. * * Example: For inputbytes = [00000111][01110001] and numBits = 12 it * returns: shiftedBytes = [01110111][00010000] * - * @param byte[] inputBytes - * @param int numBits - number of bits to be left aligned + * @param numBits - number of bits to be left aligned * @return byte[] */ public static byte[] shiftBitsToMSB(byte[] inputBytes, int numBits) { @@ -571,8 +537,8 @@ public abstract class BitBufferHelper { * Example: For inputbytes = [01110111][00010000] and numBits = 12 it * returns: shiftedBytes = [00000111][01110001] * - * @param byte[] inputBytes - * @param int numBits - number of bits to be right aligned + * @param inputBytes + * @param numBits - number of bits to be right aligned * @return byte[] */ public static byte[] shiftBitsToLSB(byte[] inputBytes, int numBits) { @@ -604,11 +570,6 @@ public abstract class BitBufferHelper { * Insert in the data buffer at position dictated by the offset the number * of bits specified from the input data byte array. The input byte array * has the bits stored starting from the LSB - * - * @param byte[] data - * @param byte[] inputdata - * @param int startOffset - * @param int numBits */ public static void insertBits(byte[] data, byte[] inputdataLSB, int startOffset, int numBits) { @@ -690,10 +651,7 @@ public abstract class BitBufferHelper { /** * Checks for overflow and underflow exceptions - * @param data - * @param startOffset - * @param numBits - * @throws PacketException when the startOffset and numBits parameters + * @throws BufferException when the startOffset and numBits parameters * are not congruent with the data buffer's size */ public static void checkExceptions(byte[] data, int startOffset, int numBits) diff --git a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/DataLinkAddress.java b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/DataLinkAddress.java index de9f4ec820..2649489569 100644 --- a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/DataLinkAddress.java +++ b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/DataLinkAddress.java @@ -37,8 +37,6 @@ abstract public class DataLinkAddress implements Serializable { * * @param name Create a new DataLink, not for general use but * available only for sub classes - * - * @return constructed object */ protected DataLinkAddress(String name) { this.name = name; diff --git a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Ethernet.java b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Ethernet.java index c2d9e7003e..424bdd016a 100644 --- a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Ethernet.java +++ b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Ethernet.java @@ -104,7 +104,7 @@ public class Ethernet extends Packet { /** * Sets the destination MAC address for the current Ethernet object instance - * @param byte[] - the destinationMACAddress to set + * @param destinationMACAddress the destinationMACAddress to set */ public Ethernet setDestinationMACAddress(byte[] destinationMACAddress) { fieldValues.put(DMAC, destinationMACAddress); @@ -113,7 +113,7 @@ public class Ethernet extends Packet { /** * Sets the source MAC address for the current Ethernet object instance - * @param byte[] - the sourceMACAddress to set + * @param sourceMACAddress the sourceMACAddress to set */ public Ethernet setSourceMACAddress(byte[] sourceMACAddress) { fieldValues.put(SMAC, sourceMACAddress); @@ -122,7 +122,7 @@ public class Ethernet extends Packet { /** * Sets the etherType for the current Ethernet object instance - * @param short - the etherType to set + * @param etherType the etherType to set */ public Ethernet setEtherType(short etherType) { byte[] ethType = BitBufferHelper.toByteArray(etherType); diff --git a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/EthernetAddress.java b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/EthernetAddress.java index a3f8d5075d..947603c45b 100644 --- a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/EthernetAddress.java +++ b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/EthernetAddress.java @@ -52,8 +52,6 @@ public class EthernetAddress extends DataLinkAddress { * * @param macAddress A byte array in big endian format * representing the Ethernet MAC Address - * - * @return The constructed object if valid */ public EthernetAddress(byte[] macAddress) throws ConstructionException { super(addressName); diff --git a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDP.java b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDP.java index 15dced5f11..bbee8599b6 100644 --- a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDP.java +++ b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDP.java @@ -90,7 +90,7 @@ public class LLDP extends Packet { } /** - * @param String + * @param type * - description of the type of TLV * @return LLDPTLV - full TLV */ @@ -103,11 +103,10 @@ public class LLDP extends Packet { } /** - * @param String + * @param type * - description of the type of TLV - * @param LLDPTLV + * @param tlv * - tlv to set - * @return void */ public void setTLV(String type, LLDPTLV tlv) { putToTLVs(getType(type), tlv); @@ -121,7 +120,7 @@ public class LLDP extends Packet { } /** - * @param LLDPTLV + * @param chassisId * - the chassisId to set */ public LLDP setChassisId(LLDPTLV chassisId) { @@ -137,8 +136,8 @@ public class LLDP extends Packet { } /** - * @param LLDPTLV - * - the chassisId to set + * @param systemNameId + * - the systemNameId to set */ public LLDP setSystemNameId(LLDPTLV systemNameId) { setTLV(SYSTEMNAMEID, systemNameId); @@ -153,7 +152,7 @@ public class LLDP extends Packet { } /** - * @param LLDPTLV + * @param portId * - the portId to set * @return LLDP */ @@ -170,7 +169,7 @@ public class LLDP extends Packet { } /** - * @param LLDPTLV + * @param ttl * - the ttl to set * @return LLDP */ @@ -206,7 +205,7 @@ public class LLDP extends Packet { } /** - * @param customTLVList + * @param customTLV * the list of custom TLVs to set * @return this LLDP */ diff --git a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDPTLV.java b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDPTLV.java index 3c5623475e..bc241928fb 100644 --- a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDPTLV.java +++ b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDPTLV.java @@ -121,7 +121,7 @@ public class LLDPTLV extends Packet { } /** - * @param byte - the type to set + * @param type the type to set * @return LLDPTLV */ public LLDPTLV setType(byte type) { @@ -131,7 +131,7 @@ public class LLDPTLV extends Packet { } /** - * @param short - the length to set + * @param length the length to set * @return LLDPTLV */ public LLDPTLV setLength(short length) { @@ -140,7 +140,7 @@ public class LLDPTLV extends Packet { } /** - * @param byte[] - the value to set + * @param value the value to set * @return LLDPTLV */ public LLDPTLV setValue(byte[] value) { @@ -266,10 +266,10 @@ public class LLDPTLV extends Packet { /** * Creates the custom TLV value including OUI, subtype and custom string * - * @param portId + * @param customString * port identifier string * @return the custom TLV value in byte array - * @see {@link #createCustomTLVValue(byte,String)} + * @see #createCustomTLVValue(byte[],byte[]) */ static public byte[] createCustomTLVValue(String customString) { byte[] customByteArray = customString.getBytes(Charset.defaultCharset()); @@ -279,7 +279,7 @@ public class LLDPTLV extends Packet { /** * Creates the custom TLV value including OUI, subtype and custom string * @param subtype openflow subtype - * @param portId + * @param customByteArray * port identifier string * @return the custom TLV value in byte array */ diff --git a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Packet.java b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Packet.java index 59a786339d..8a4fa36970 100644 --- a/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Packet.java +++ b/opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Packet.java @@ -76,10 +76,10 @@ public abstract class Packet { * This method deserializes the data bits obtained from the wire into the * respective header and payload which are of type Packet * - * @param byte[] data - data from wire to deserialize - * @param int bitOffset bit position where packet header starts in data + * @param data - data from wire to deserialize + * @param bitOffset bit position where packet header starts in data * array - * @param int size of packet in bits + * @param size size of packet in bits * @return Packet * @throws PacketException */ @@ -205,7 +205,7 @@ public abstract class Packet { * normal Packet.serialize() path. An example is the checksum computation * for IPv4 * - * @param byte[] - serialized bytes + * @param myBytes serialized bytes * @throws PacketException */ protected void postSerializeCustomOperation(byte[] myBytes) @@ -220,8 +220,8 @@ public abstract class Packet { * Currently only IPv4 and ICMP do checksum computation and validation. TCP * and UDP need to implement these if required. * - * @param byte[] data The byte stream representing the Ethernet frame - * @param int startBitOffset The bit offset from where the byte array corresponding to this Packet starts in the frame + * @param data The byte stream representing the Ethernet frame + * @param startBitOffset The bit offset from where the byte array corresponding to this Packet starts in the frame * @throws PacketException */ protected void postDeserializeCustomOperation(byte[] data, int startBitOffset) @@ -255,8 +255,6 @@ public abstract class Packet { * 'fieldname'. The offset is present in the hdrFieldCoordMap of the * respective packet class * - * @param String - * fieldName * @return Integer - startOffset of the requested field */ public int getfieldOffset(String fieldName) { @@ -268,8 +266,6 @@ public abstract class Packet { * 'fieldname'. The numBits are present in the hdrFieldCoordMap of the * respective packet class * - * @param String - * fieldName * @return Integer - number of bits of the requested field */ public int getfieldnumBits(String fieldName) { diff --git a/opendaylight/commons/protocol-framework/pom.xml b/opendaylight/commons/protocol-framework/pom.xml index b97be83fe6..e6029f77d0 100644 --- a/opendaylight/commons/protocol-framework/pom.xml +++ b/opendaylight/commons/protocol-framework/pom.xml @@ -114,27 +114,6 @@ - - - - jdk8 - - [1.8,) - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - - - scm:git:http://git.opendaylight.org/gerrit/controller.git scm:git:ssh://git.opendaylight.org:29418/controller.git diff --git a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java index 334ccc2cc3..e153861eb8 100644 --- a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java +++ b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java @@ -147,7 +147,7 @@ public abstract class AbstractDispatcher, L extends * Creates a client. * * @param address remote address - * @param connectStrategy Reconnection strategy to be used when initial connection fails + * @param strategy Reconnection strategy to be used when initial connection fails * * @return Future representing the connection process. Its result represents the combined success of TCP connection * as well as session negotiation. @@ -266,7 +266,7 @@ public abstract class AbstractDispatcher, L extends } /** - * @deprecated Should only be used with {@link AbstractDispatcher#AbstractDispatcher()} + * @deprecated Should only be used with AbstractDispatcher#AbstractDispatcher() */ @Deprecated @Override diff --git a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java index 8a19828c57..ddd10d2ce5 100644 --- a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java +++ b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java @@ -25,7 +25,7 @@ import com.google.common.base.Preconditions; * needing to provide only * * @param Protocol message type - * @param Protocol session type, has to extend ProtocolSession + * @param Protocol session type, has to extend {@code ProtocolSession} */ @Deprecated public abstract class AbstractSessionNegotiator> extends ChannelInboundHandlerAdapter implements SessionNegotiator { diff --git a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/SessionListener.java b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/SessionListener.java index dfe0208c54..06b2730730 100644 --- a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/SessionListener.java +++ b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/SessionListener.java @@ -19,7 +19,7 @@ public interface SessionListener, T extends Term /** * Fired when the session was established successfully. * - * @param remoteParams Peer address families which we accepted + * @param session New session */ void onSessionUp(S session); diff --git a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java index ecb9e65a52..ed60abb05a 100644 --- a/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java +++ b/opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java @@ -29,7 +29,7 @@ import com.google.common.base.Preconditions; * * Initial sleep time is specified as minSleep. Each subsequent unsuccessful attempt multiplies this time by a constant * factor (sleepFactor) -- this allows for either constant reconnect times (sleepFactor = 1), or various degrees of - * exponential back-off (sleepFactor > 1). Maximum sleep time between attempts can be capped to a specific value + * exponential back-off (sleepFactor > 1). Maximum sleep time between attempts can be capped to a specific value * (maxSleep). * * The strategy can optionally give up based on two criteria: diff --git a/opendaylight/config/config-api/pom.xml b/opendaylight/config/config-api/pom.xml index 74c384d238..bc438e6b5e 100644 --- a/opendaylight/config/config-api/pom.xml +++ b/opendaylight/config/config-api/pom.xml @@ -54,26 +54,4 @@ - - - - - jdk8 - - [1.8,) - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - - diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigRegistry.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigRegistry.java index 275858cbed..77b555c6e9 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigRegistry.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigRegistry.java @@ -29,7 +29,8 @@ public interface ConfigRegistry extends LookupRegistry, ServiceReferenceReadable /** * Opens new configuration transaction. * - * @return {@link ObjectName} of {@link ConfigTransactionControllerMXBean} + * @return {@link ObjectName} of + * {@link org.opendaylight.controller.config.api.jmx.ConfigTransactionControllerMXBean} */ ObjectName beginConfig(); @@ -38,8 +39,8 @@ public interface ConfigRegistry extends LookupRegistry, ServiceReferenceReadable * * @param transactionControllerON * {@link ObjectName} of - * {@link ConfigTransactionControllerMXBean} that was received in - * {@link #beginConfig()} method call. + * {@link org.opendaylight.controller.config.api.jmx.ConfigTransactionControllerMXBean} that was + * received in {@link #beginConfig()} method call. * @return CommitStatus * @throws ValidationException * if validation fails diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/RuntimeBeanRegistratorAwareModule.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/RuntimeBeanRegistratorAwareModule.java index 41673bce72..e6c92fdb6d 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/RuntimeBeanRegistratorAwareModule.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/RuntimeBeanRegistratorAwareModule.java @@ -18,7 +18,7 @@ public interface RuntimeBeanRegistratorAwareModule extends Module { /** * Configuration framework will call this setter on all modules implementing * this interface. It is responsibility of modules or rather their instances - * to close registrator in their {@link Closeable#close()} method. Same + * to close registrator in their {@link java.io.Closeable#close()} method. Same * module will get the same registrator during reconfiguration. * * @param rootRuntimeBeanRegistrator diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ServiceReferenceWritableRegistry.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ServiceReferenceWritableRegistry.java index fa2aa1f56e..f7b56fe4c2 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ServiceReferenceWritableRegistry.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ServiceReferenceWritableRegistry.java @@ -21,7 +21,6 @@ public interface ServiceReferenceWritableRegistry extends ServiceReferenceReadab /** * Remove service reference. - * @return true iif removed * @throws IllegalArgumentException if service interface name is not advertised by any module */ void removeServiceReference(String serviceInterfaceName, String refName) throws InstanceNotFoundException; diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/annotations/RequireInterface.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/annotations/RequireInterface.java index aacafad74f..0e8f6fd736 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/annotations/RequireInterface.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/annotations/RequireInterface.java @@ -17,16 +17,15 @@ import java.lang.annotation.Target; * of a module. This annotation must be present for each dependency setter in * {@link org.opendaylight.controller.config.spi.Module} M(X)Bean interface. * Together with name of dependent bean the {@link #value()} will be used to get - * {@link ObjectName} of dependency. + * {@link javax.management.ObjectName} of dependency. * *

* Example:
* * - * - * @RequireInterface(value = ThreadPoolServiceInterface.class, optional = - * false)
void setThreadPool(ObjectName on); - *
+ * {@literal @}RequireInterface(value = ThreadPoolServiceInterface.class, optional = false)
+ * void setThreadPool(ObjectName on); + * */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/ConfigTransactionControllerMXBean.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/ConfigTransactionControllerMXBean.java index e5123e2bee..b59bf2d736 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/ConfigTransactionControllerMXBean.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/ConfigTransactionControllerMXBean.java @@ -11,7 +11,7 @@ import org.opendaylight.controller.config.api.ConfigTransactionController; /** * Those are executed by Jolokia clients on configuration transaction - * represented by {@link ConfigMBeanServer} instance. Note: Reason for having + * represented by ConfigMBeanServer instance. Note: Reason for having * methods in super interface is that JMX allows only one MXBean to be * implemented and implementations can expose additional methods to be exported.
* Implementation of {@link ConfigTransactionController} is not required to diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/notifications/ConfigJMXNotification.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/notifications/ConfigJMXNotification.java index 13efafb79d..2548711aa2 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/notifications/ConfigJMXNotification.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/notifications/ConfigJMXNotification.java @@ -49,9 +49,6 @@ public abstract class ConfigJMXNotification extends Notification { * Creates notification about successful commit execution. * * Intended for config-persister. - * - * @param transactionName - * @param cfgSnapshot */ public static CommitJMXNotification afterCommit(NotificationBroadcasterSupport source, String messages) { return new CommitJMXNotification(source, messages); diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/AbstractModule.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/AbstractModule.java index 7fcc0cc5c0..9f6a5512ca 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/AbstractModule.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/AbstractModule.java @@ -15,7 +15,7 @@ import org.slf4j.LoggerFactory; /** * Base implementation of Module. This implementation contains base logic for Module reconfiguration with associated fields. - * @param Type of module implementation. Enables easier implementation for the {@link #isSame} method + * @param Type of module implementation. Enables easier implementation for the isSame() method */ public abstract class AbstractModule> implements org.opendaylight.controller.config.spi.Module { diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/ModuleFactory.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/ModuleFactory.java index 9926363265..1a8c140c63 100644 --- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/ModuleFactory.java +++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/ModuleFactory.java @@ -15,12 +15,12 @@ import org.opendaylight.controller.config.api.annotations.AbstractServiceInterfa import org.osgi.framework.BundleContext; /** - * Factory which creates {@link Module instances. An instance of this interface + * Factory which creates {@link Module} instances. An instance of this interface * needs to be exported into the OSGi Service Registry. Such an instance * provides metadata describing services which can be published from it. * - * Each {@link Module } can optionally be instantiated with a - * {@link DynamicMBean} which represents the configuration of the currently + * Each {@link Module} can optionally be instantiated with a + * {@link javax.management.DynamicMBean} which represents the configuration of the currently * running instance. */ public interface ModuleFactory { @@ -56,7 +56,7 @@ public interface ModuleFactory { * Create a new Module instance. The returned object is expected to use the * dependencyResolver provided when resolving ObjectNames to actual Module * instances. A reference to an abstract view of the previous configuration - * is also provided in the form of a {@link DynamicMBean}. Implementations + * is also provided in the form of a {@link javax.management.DynamicMBean}. Implementations * should use the MBeanInfo interface to understand the structure of the * configuration information. * @@ -71,7 +71,7 @@ public interface ModuleFactory { * @param old * existing module from platform MBeanServer that is being * reconfigured. Implementations should inspect its attributes - * using {@link DynamicMBean#getAttribute(String)} and set those + * using {@link javax.management.DynamicMBean#getAttribute(String)} and set those * attributes on newly created module. If reconfiguration of live * instances is supported, this live instance can be retreived * using diff --git a/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/ConfigSubsystemFacade.java b/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/ConfigSubsystemFacade.java index d70376f579..d47383469a 100644 --- a/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/ConfigSubsystemFacade.java +++ b/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/ConfigSubsystemFacade.java @@ -59,7 +59,7 @@ import org.w3c.dom.Element; /** * Config subsystem facade for xml format - *

+ *

* TODO extract generic interface for config subsystem facades */ public class ConfigSubsystemFacade implements Closeable { diff --git a/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/attributes/fromxml/ArrayAttributeReadingStrategy.java b/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/attributes/fromxml/ArrayAttributeReadingStrategy.java index f80494fcb2..5f169de9fb 100644 --- a/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/attributes/fromxml/ArrayAttributeReadingStrategy.java +++ b/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/attributes/fromxml/ArrayAttributeReadingStrategy.java @@ -18,10 +18,6 @@ public class ArrayAttributeReadingStrategy extends AbstractAttributeReadingStrat private final AttributeReadingStrategy innerStrategy; - /** - * @param attributeIfc - * @param innerStrategy - */ public ArrayAttributeReadingStrategy(String nullableDefault, AttributeReadingStrategy innerStrategy) { super(nullableDefault); this.innerStrategy = innerStrategy; diff --git a/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/config/Config.java b/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/config/Config.java index 30726db82e..10602ce7e5 100644 --- a/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/config/Config.java +++ b/opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/config/Config.java @@ -160,7 +160,7 @@ public class Config { } /** - * return a map containing namespace -> moduleName -> instanceName map. Attribute parsing is omitted. + * return a map containing namespace -> moduleName -> instanceName map. Attribute parsing is omitted. */ public Map> fromXmlModulesMap(XmlElement xml, EditStrategyType defaultEditStrategyType, ServiceRegistryWrapper serviceTracker) throws DocumentedException { diff --git a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/dynamicmbean/DynamicWritableWrapper.java b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/dynamicmbean/DynamicWritableWrapper.java index 894858d9d0..67ed296f61 100644 --- a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/dynamicmbean/DynamicWritableWrapper.java +++ b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/dynamicmbean/DynamicWritableWrapper.java @@ -40,7 +40,7 @@ import org.slf4j.LoggerFactory; * of {@link org.opendaylight.controller.config.spi.Module#validate()} and * {@link org.opendaylight.controller.config.spi.Module#getInstance()} is also * guaranteed by - * {@link org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerInternal} + * org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerInternal * so the actual {@link org.opendaylight.controller.config.spi.Module} needs not * to be thread safe. *

diff --git a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/factoriesresolver/ModuleFactoriesResolver.java b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/factoriesresolver/ModuleFactoriesResolver.java index 84e7270c94..15122b4696 100644 --- a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/factoriesresolver/ModuleFactoriesResolver.java +++ b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/factoriesresolver/ModuleFactoriesResolver.java @@ -12,7 +12,7 @@ import org.opendaylight.controller.config.spi.ModuleFactory; import org.osgi.framework.BundleContext; /** - * {@link org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerImpl} + * org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerImpl * receives list of factories using this interface. For testing, this could be * implemented as hard coded list of objects, for OSGi this would look for all * services in OSGi Service Registry are registered under diff --git a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/jmx/ModuleJMXRegistrator.java b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/jmx/ModuleJMXRegistrator.java index 70ed69543a..206a623990 100644 --- a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/jmx/ModuleJMXRegistrator.java +++ b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/jmx/ModuleJMXRegistrator.java @@ -16,7 +16,7 @@ import org.opendaylight.controller.config.api.jmx.ObjectNameUtil; /** * This subclass is used for registering readable module into JMX, it is also - * used as underlying provider in {@link RuntimeBeanRegistratorImpl}. Closing + * used as underlying provider in RuntimeBeanRegistratorImpl. Closing * the instance thus unregisters all JMX beans related to the module excluding * currently open transactions. */ diff --git a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/osgi/ExtensibleBundleTracker.java b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/osgi/ExtensibleBundleTracker.java index 62215d6626..6969a3b657 100644 --- a/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/osgi/ExtensibleBundleTracker.java +++ b/opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/osgi/ExtensibleBundleTracker.java @@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory; * * Primary customizer may return tracking object, * which will be passed to it during invocation of - * {@link BundleTrackerCustomizer#removedBundle(Bundle, BundleEvent, Future)} + * {@link BundleTrackerCustomizer#removedBundle(Bundle, BundleEvent, Object)} * * * This extender modifies behaviour to not leak platform thread diff --git a/opendaylight/config/pom.xml b/opendaylight/config/pom.xml index 66c89d243c..9bbfa4d4d7 100644 --- a/opendaylight/config/pom.xml +++ b/opendaylight/config/pom.xml @@ -68,23 +68,5 @@ yang-jmx-generator-it - - - jdk8 - - [1.8,) - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - diff --git a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntry.java b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntry.java index 773025c3cf..3d50ac3fe4 100644 --- a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntry.java +++ b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntry.java @@ -56,7 +56,6 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext; * * * - *

*/ public class ModuleMXBeanEntry extends AbstractEntry { diff --git a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/PackageTranslator.java b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/PackageTranslator.java index 2b130e3188..48895d2169 100644 --- a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/PackageTranslator.java +++ b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/PackageTranslator.java @@ -13,9 +13,8 @@ import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil; import org.opendaylight.yangtools.yang.model.api.Module; /** - * Maps from module namespaces to java package names using a Map, where key is namespace prefix and value is package that replaces - * matched prefix. + * Maps from module namespaces to java package names using a Map<String, String>, + * where key is namespace prefix and value is package that replaces matched prefix. */ public class PackageTranslator { private final Map namespacePrefixToPackageMap; diff --git a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ServiceInterfaceEntry.java b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ServiceInterfaceEntry.java index 2c853e1537..4cd0feb086 100644 --- a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ServiceInterfaceEntry.java +++ b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ServiceInterfaceEntry.java @@ -43,7 +43,6 @@ import org.slf4j.LoggerFactory; * * * - *

*/ public class ServiceInterfaceEntry extends AbstractEntry { private static final Logger LOG = LoggerFactory diff --git a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/attribute/AbstractAttribute.java b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/attribute/AbstractAttribute.java index d9a6dd0452..697f022297 100644 --- a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/attribute/AbstractAttribute.java +++ b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/attribute/AbstractAttribute.java @@ -60,7 +60,7 @@ public abstract class AbstractAttribute implements AttributeIfc { * * @return Yang name converted to cammel case, starting with a capital * letter. For details see - * {@link ModuleMXBeanEntry#findJavaNamePrefix(org.opendaylight.yangtools.yang.model.api.SchemaNode)} + * {@link org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry#getJavaNamePrefix()} */ @Override public String getUpperCaseCammelCase() { diff --git a/opendaylight/md-sal/messagebus-spi/pom.xml b/opendaylight/md-sal/messagebus-spi/pom.xml index 07460138ba..2431472709 100644 --- a/opendaylight/md-sal/messagebus-spi/pom.xml +++ b/opendaylight/md-sal/messagebus-spi/pom.xml @@ -44,27 +44,6 @@ - - - - jdk8 - - [1.8,) - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - - - scm:git:http://git.opendaylight.org/gerrit/controller.git scm:git:ssh://git.opendaylight.org:29418/controller.git diff --git a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java index 6a6266a0c6..6880775461 100644 --- a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java +++ b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java @@ -15,7 +15,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath; /** * Event source is a node in topology which is able to produces notifications. - * To register event source you use {@link EventSourceRegistry#registerEventSource(EventSource)()}. + * To register event source you use {@link EventSourceRegistry#registerEventSource(EventSource)}. * EventSourceRegistry will request registered event source to publish notifications * whenever EventSourceRegistry has been asked to publish a certain type of notifications. * EventSourceRegistry will call method JoinTopic to request EventSource to publish notification. @@ -38,4 +38,4 @@ public interface EventSource extends EventSourceService, AutoCloseable { */ List getAvailableNotifications(); -} \ No newline at end of file +} diff --git a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java index 10d3b5b112..8f9b53074d 100644 --- a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java +++ b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java @@ -8,18 +8,17 @@ package org.opendaylight.controller.messagebus.spi; /** - *EventSourceRegistry is used to register {@link EventSource}. - * + * EventSourceRegistry is used to register {@link EventSource}. */ public interface EventSourceRegistry extends AutoCloseable { /** * Registers the given EventSource for public consumption. The EventSource is - * associated with the node identified via {@linkEventSource#getSourceNodeKey}. + * associated with the node identified via {@link EventSource#getSourceNodeKey}. * * @param eventSource the EventSource instance to register - * @return an EventSourceRegistration instance that is used to unregister the EventSource via {@link EventSourceRegistrationImpl#close()}. + * @return an EventSourceRegistration instance that is used to unregister the EventSource via {@link EventSourceRegistration#close()}. */ EventSourceRegistration registerEventSource(T eventSource); -} \ No newline at end of file +} diff --git a/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java b/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java index cc2066256d..02247ff734 100644 --- a/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java +++ b/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java @@ -31,7 +31,7 @@ public final class Util { * Method filters qnames based on wildcard strings * * @param list - * @param patterh matching pattern + * @param pattern matching pattern * @return list of filtered qnames */ public static List expandQname(final List list, final Pattern pattern) { diff --git a/opendaylight/md-sal/pom.xml b/opendaylight/md-sal/pom.xml index fc04389f1a..0137360e17 100644 --- a/opendaylight/md-sal/pom.xml +++ b/opendaylight/md-sal/pom.xml @@ -159,23 +159,5 @@ benchmark-data-store - - - jdk8 - - [1.8,) - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - diff --git a/opendaylight/md-sal/sal-akka-raft-example/src/main/java/org/opendaylight/controller/cluster/example/ExampleRoleChangeListener.java b/opendaylight/md-sal/sal-akka-raft-example/src/main/java/org/opendaylight/controller/cluster/example/ExampleRoleChangeListener.java index 29e8a477e8..f6930e8b09 100644 --- a/opendaylight/md-sal/sal-akka-raft-example/src/main/java/org/opendaylight/controller/cluster/example/ExampleRoleChangeListener.java +++ b/opendaylight/md-sal/sal-akka-raft-example/src/main/java/org/opendaylight/controller/cluster/example/ExampleRoleChangeListener.java @@ -24,11 +24,11 @@ import scala.concurrent.duration.FiniteDuration; /** * This is a sample implementation of a Role Change Listener which is an actor, which registers itself to the ClusterRoleChangeNotifier - *

+ *

* The Role Change listener receives a SetNotifiers message with the notifiers to register itself with. - *

+ *

* It kicks of a scheduler which sents registration messages to the notifiers, till it gets a RegisterRoleChangeListenerReply - *

+ *

* If all the notifiers have been regsitered with, then it cancels the scheduler. * It starts the scheduler again when it receives a new registration * diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ConfigParams.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ConfigParams.java index 652771b4f1..0e701e3aa5 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ConfigParams.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ConfigParams.java @@ -13,10 +13,12 @@ import scala.concurrent.duration.FiniteDuration; /** * Configuration Parameter interface for configuring the Raft consensus system - *

+ * + *

* Any component using this implementation might want to provide an implementation of * this interface to configure - *

+ * + *

* A default implementation will be used if none is provided. * * @author Kamal Rameshan diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/DefaultConfigParamsImpl.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/DefaultConfigParamsImpl.java index 2d2f95bd76..317ce6a220 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/DefaultConfigParamsImpl.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/DefaultConfigParamsImpl.java @@ -41,7 +41,8 @@ public class DefaultConfigParamsImpl implements ConfigParams { /** * The interval at which a heart beat message will be sent to the remote * RaftActor. - *

+ * + *

* Since this is set to 100 milliseconds the Election timeout should be * at least 200 milliseconds */ diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ElectionTerm.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ElectionTerm.java index e8c9b458c6..264f7a5d63 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ElectionTerm.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ElectionTerm.java @@ -12,10 +12,12 @@ import javax.annotation.Nullable; /** * ElectionTerm contains information about a RaftActors election term. - *

+ * + *

* This information includes the last known current term of the RaftActor * and which candidate was voted for by the RaftActor in that term. - *

+ * + *

* This class ensures that election term information is persisted. */ public interface ElectionTerm { diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActor.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActor.java index 8d29614105..e3fa649ab1 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActor.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActor.java @@ -59,7 +59,8 @@ import org.opendaylight.yangtools.concepts.Immutable; * in a cluster. It implements the RAFT algorithm as described in the paper * * In Search of an Understandable Consensus Algorithm - *

+ * + *

* RaftActor has 3 states and each state has a certain behavior associated * with it. A Raft actor can behave as, *

    @@ -67,27 +68,26 @@ import org.opendaylight.yangtools.concepts.Immutable; *
  • A Follower (or)
  • *
  • A Candidate
  • *
- *

- *

+ * + *

* A RaftActor MUST be a Leader in order to accept requests from clients to * change the state of it's encapsulated state machine. Once a RaftActor becomes * a Leader it is also responsible for ensuring that all followers ultimately * have the same log and therefore the same state machine as itself. - *

- *

+ * + *

* The current behavior of a RaftActor determines how election for leadership * is initiated and how peer RaftActors react to request for votes. - *

- *

+ * + *

* Each RaftActor also needs to know the current election term. It uses this * information for a couple of things. One is to simply figure out who it * voted for in the last election. Another is to figure out if the message * it received to update it's state is stale. - *

- *

+ * + *

* The RaftActor uses akka-persistence to store it's replicated log. * Furthermore through it's behaviors a Raft Actor determines - *

*

    *
  • when a log entry should be persisted
  • *
  • when a log entry should be applied to the state machine (and)
  • diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorLeadershipTransferCohort.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorLeadershipTransferCohort.java index f3ffe13947..b087914dec 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorLeadershipTransferCohort.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorLeadershipTransferCohort.java @@ -26,7 +26,8 @@ import scala.concurrent.duration.FiniteDuration; /** * A raft actor support class that participates in leadership transfer. An instance is created upon * initialization of leadership transfer. - *

    + * + *

    * The transfer process is as follows: *

      *
    1. Send a LeaderStateChanged message with a null leader Id to the local RoleChangeNotifier to notify @@ -35,14 +36,15 @@ import scala.concurrent.duration.FiniteDuration; * their local RoleChangeNotifiers.
    2. *
    3. Call {@link RaftActor#pauseLeader} passing this RaftActorLeadershipTransferCohort * instance. This allows derived classes to perform work prior to transferring leadership.
    4. - *
    5. When the pause is complete, the {@link #run} method is called which in turn calls - * {@link Leader#transferLeadership}.
    6. + *
    7. When the pause is complete, the run method is called which in turn calls + * {@link Leader#transferLeadership(RaftActorLeadershipTransferCohort)}.
    8. *
    9. The Leader calls {@link #transferComplete} on successful completion.
    10. *
    11. Wait a short period of time for the new leader to be elected to give the derived class a chance to * possibly complete work that was suspended while we were transferring.
    12. *
    13. On notification of the new leader from the RaftActor or on time out, notify {@link OnComplete} callbacks.
    14. *
    - *

    + * + *

    * NOTE: All methods on this class must be called on the actor's thread dispatcher as they may access/modify * internal state. * diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java index 73ab6ea66c..cd70812d9d 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java @@ -61,7 +61,8 @@ public interface ReplicatedLog { /** * Removes entries from the in-memory log and the persisted log starting at the given index. - *

    + * + *

    * The persisted information would then be used during recovery to properly * reconstruct the state of the in-memory replicated log * diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java index fab1714989..31bf99c2dc 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java @@ -50,7 +50,8 @@ import scala.concurrent.duration.FiniteDuration; /** * The behavior of a RaftActor when it is in the Leader state - *

    + * + *

    * Leaders: *

      *
    • Upon election: send initial empty AppendEntries RPCs @@ -64,7 +65,7 @@ import scala.concurrent.duration.FiniteDuration; * follower (§5.3) *
    • If AppendEntries fails because of log inconsistency: * decrement nextIndex and retry (§5.3) - *
    • If there exists an N such that N > commitIndex, a majority + *
    • If there exists an N such that N > commitIndex, a majority * of matchIndex[i] ≥ N, and log[N].term == currentTerm: * set commitIndex = N (§5.3, §5.4). *
    @@ -699,7 +700,8 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { /** * Initiates a snapshot capture to install on a follower. - *

    + * + *

    * Install Snapshot works as follows * 1. Leader initiates the capture snapshot by calling createSnapshot on the RaftActor. * 2. On receipt of the CaptureSnapshotReply message, the RaftActor persists the snapshot and makes a call to diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java index b86d28b5f7..ac7dbaba27 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java @@ -24,7 +24,8 @@ import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply; /** * The behavior of a RaftActor when it is in the Candidate raft state. - *

    + * + *

    * Candidates (§5.2): *

      *
    • On conversion to candidate, start election: diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Follower.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Follower.java index 3f68b50a4f..d4747da09d 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Follower.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Follower.java @@ -41,7 +41,6 @@ import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPay /** * The behavior of a RaftActor in the Follower raft state. - *

      *

        *
      • Respond to RPCs from candidates and leaders *
      • If election timeout elapses without receiving AppendEntries diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/IsolatedLeader.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/IsolatedLeader.java index 658c129e2d..9ba39c2fcc 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/IsolatedLeader.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/IsolatedLeader.java @@ -15,16 +15,18 @@ import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; /** * Leader which is termed as isolated. - *

        + * + *

        * If the reply from the majority of the followers is not received then the leader changes its behavior * to IsolatedLeader. An isolated leader may have followers and they would continue to receive replicated messages. - *

        + * + *

        * A schedule is run, at an interval of (10 * Heartbeat-time-interval), in the Leader * to check if its isolated or not. - *

        + * + *

        * In the Isolated Leader , on every AppendEntriesReply, we aggressively check if the leader is isolated. * If no, then the state is switched back to Leader. - * */ public class IsolatedLeader extends AbstractLeader { IsolatedLeader(RaftActorContext context, @Nullable AbstractLeader initializeFromLeader) { diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Leader.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Leader.java index 4821d98835..f5f3f51819 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Leader.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Leader.java @@ -24,7 +24,8 @@ import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; /** * The behavior of a RaftActor when it is in the Leader state. - *

        + * + *

        * Leaders: *

          *
        • Upon election: send initial empty AppendEntries RPCs @@ -38,7 +39,7 @@ import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; * follower (§5.3) *
        • If AppendEntries fails because of log inconsistency: * decrement nextIndex and retry (§5.3) - *
        • If there exists an N such that N > commitIndex, a majority + *
        • If there exists an N such that N > commitIndex, a majority * of matchIndex[i] ≥ N, and log[N].term == currentTerm: * set commitIndex = N (§5.3, §5.4). *
        @@ -107,14 +108,14 @@ public class Leader extends AbstractLeader { *
      • Start a timer (Stopwatch).
      • *
      • Send an initial AppendEntries heartbeat to all followers.
      • *
      • On AppendEntriesReply, check if the follower's new match Index matches the leader's last index
      • - *
      • If it matches,
      • + *
      • If it matches, *
          *
        • Send an additional AppendEntries to ensure the follower has applied all its log entries to its state.
        • *
        • Send an ElectionTimeout to the follower to immediately start an election.
        • *
        • Notify {@link RaftActorLeadershipTransferCohort#transferComplete}.
        • - *
        + *
    • *
    • Otherwise if the election time out period elapses, notify - * {@link RaftActorLeadershipTransferCohort#abortTtransfer}.
    • + * {@link RaftActorLeadershipTransferCohort#abortTransfer}. *
    * * @param leadershipTransferCohort the cohort participating in the leadership transfer diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/PreLeader.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/PreLeader.java index 09f5186a01..bb54688437 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/PreLeader.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/PreLeader.java @@ -22,7 +22,8 @@ import org.opendaylight.controller.cluster.raft.persisted.NoopPayload; * the log with the leader's current term. Once the no-op entry is committed, all prior entries are committed * indirectly. Once all entries are committed, ie commitIndex matches the last log index, it switches to the * normal Leader state. - *

    + * + *

    * The use of a no-op entry in this manner is outlined in the last paragraph in §8 of the * extended raft version. * diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeader.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeader.java index 8f23a89b8b..945ace7410 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeader.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeader.java @@ -15,7 +15,8 @@ import java.io.Serializable; * Request to locate the leader raft actor. Each {@link org.opendaylight.controller.cluster.raft.RaftActor} must * respond with a {@link FindLeaderReply} containing the address of the leader, as it is known to that particular * actor. - *

    + * + *

    * This message is intended for testing purposes only. */ @VisibleForTesting diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java index 5fbeb92fbd..90cec9db6c 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java @@ -17,7 +17,8 @@ import javax.annotation.Nullable; * Reply to {@link FindLeader} message, containing the address of the leader actor, as known to the raft actor which * sent the message. If the responding actor does not have knowledge of the leader, {@link #getLeaderActor()} will * return {@link Optional#empty()}. - *

    + * + *

    * This message is intended for testing purposes only. */ @VisibleForTesting diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/policy/RaftPolicy.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/policy/RaftPolicy.java index c535c2299d..183e3400e6 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/policy/RaftPolicy.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/policy/RaftPolicy.java @@ -13,12 +13,12 @@ package org.opendaylight.controller.cluster.raft.policy; * we may want to be able to determine which Raft replica should become the leader - with Raft elections are * randomized so it is not possible to specify which replica should be the leader. The ability to specify * the leader would be quite useful when testing a raft cluster. - *

    + * + *

    * Similarly we may want to customize when exactly we apply a modification to the state - with Raft a modification * is only applied to the state when the modification is replicated to a majority of the replicas. The ability to * apply a modification to the state before consensus would be useful in scenarios where you have only 2 nodes * in a Raft cluster and one of them is down but you still want the RaftActor to apply a modification to the state. - * */ public interface RaftPolicy { /** diff --git a/opendaylight/md-sal/sal-binding-api/pom.xml b/opendaylight/md-sal/sal-binding-api/pom.xml index e8d6a45c1e..08141e8b58 100644 --- a/opendaylight/md-sal/sal-binding-api/pom.xml +++ b/opendaylight/md-sal/sal-binding-api/pom.xml @@ -42,26 +42,4 @@ HEAD https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL - - - - - jdk8 - - [1.8,) - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - - diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ClusteredDataChangeListener.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ClusteredDataChangeListener.java index d9f0e08551..54692f480a 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ClusteredDataChangeListener.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ClusteredDataChangeListener.java @@ -19,8 +19,8 @@ package org.opendaylight.controller.md.sal.binding.api; * to data change notifications on any node of clustered datastore. DataChangeListener enables data change notifications * only at leader of the datastore shard.

    * - * @Deprecated Replaced by {@link ClusteredDataTreeChangeListener} + * @deprecated Replaced by {@link ClusteredDataTreeChangeListener} */ @Deprecated -public interface ClusteredDataChangeListener extends DataChangeListener{ +public interface ClusteredDataChangeListener extends DataChangeListener { } diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java index afeb21c530..f8dd3b0cce 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java @@ -69,7 +69,6 @@ public interface DataObjectModification extends org.openda * Returns before-state of top level container. Implementations are encouraged, * but not required to provide this state. * - * @param root Class representing data container * @return State of object before modification. Null if subtree was not present, * or the implementation cannot provide the state. */ @@ -78,7 +77,6 @@ public interface DataObjectModification extends org.openda /** * Returns after-state of top level container. * - * @param root Class representing data container * @return State of object after modification. Null if subtree is not present. */ @Nullable T getDataAfter(); diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeChangeService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeChangeService.java index 9d12e44916..f899eb13e4 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeChangeService.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeChangeService.java @@ -12,7 +12,7 @@ import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.yang.binding.DataObject; /** - * A {@link DOMService} which allows users to register for changes to a + * A {@link BindingService} which allows users to register for changes to a * subtree. */ public interface DataTreeChangeService extends BindingService { @@ -52,4 +52,4 @@ public interface DataTreeChangeService extends BindingService { * delivery of change events. */ @Nonnull > ListenerRegistration registerDataTreeChangeListener(@Nonnull DataTreeIdentifier treeId, @Nonnull L listener); -} \ No newline at end of file +} diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeIdentifier.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeIdentifier.java index a90d6da28a..13d0a92600 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeIdentifier.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeIdentifier.java @@ -40,7 +40,7 @@ public final class DataTreeIdentifier implements Immutable } /** - * Return the {@link YangInstanceIdentifier} of the root node. + * Return the {@link InstanceIdentifier} of the root node. * * @return Instance identifier corresponding to the root node. */ @@ -82,4 +82,4 @@ public final class DataTreeIdentifier implements Immutable return getClass().getSimpleName() + "{datastoreType = " + datastoreType + ", rootIdentifier = " + rootIdentifier + "}"; } -} \ No newline at end of file +} diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationPublishService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationPublishService.java index 7f8b734a7a..393839ce58 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationPublishService.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationPublishService.java @@ -61,7 +61,7 @@ public interface NotificationPublishService extends BindingService { * @param notification * the notification to publish. * @return A listenable future which will report completion when the service has finished - * propagating the notification to its immediate registrants, or {@value #REJECTED} if resource + * propagating the notification to its immediate registrants, or {@link #REJECTED} if resource * constraints prevent * @throws NullPointerException if the notification is null */ @@ -80,7 +80,7 @@ public interface NotificationPublishService extends BindingService { * @param unit a TimeUnit determining how to interpret the * timeout parameter * @return A listenable future which will report completion when the service has finished - * propagating the notification to its immediate registrants, or {@value #REJECTED} if resource + * propagating the notification to its immediate registrants, or {@link #REJECTED} if resource * constraints prevent * @throws InterruptedException if interrupted while waiting * @throws NullPointerException if the notification or unit is null diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java index ba352359cc..c0e8ea5fee 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java @@ -21,7 +21,7 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener; * are registered using {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)} * method. * - *
    Dispatch Listener Example
    + *

    Dispatch Listener Example

    *

    * Lets assume we have following YANG model: * @@ -40,14 +40,14 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener; * * * The generated interface will be: - *

    + * {@code
      *  public interface ExampleListener extends NotificationListener {
      *      void onStart(Start notification);
      *      void onStop(Stop notification);
      *  }
    - * 
    + * } * The following defines an implementation of the generated interface: - *
    + * {@code
      *  public class MyExampleListener implements ExampleListener {
      *      public void onStart(Start notification) {
      *          // do something
    @@ -57,12 +57,12 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
      *          // do something
      *      }
      *  }
    - * 
    + * } * The implementation is registered as follows: - *
    + * {@code
      *  MyExampleListener listener = new MyExampleListener();
      *  ListenerRegistration reg = service.registerNotificationListener( listener );
    - * 
    + * } * The onStart method will be invoked when someone publishes a Start notification and * the onStop method will be invoked when someone publishes a Stop notification. */ diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/AbstractBrokerAwareActivator.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/AbstractBrokerAwareActivator.java index bd78c584ee..9972ce7b8a 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/AbstractBrokerAwareActivator.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/AbstractBrokerAwareActivator.java @@ -78,7 +78,7 @@ public abstract class AbstractBrokerAwareActivator implements BundleActivator { /** * Called when this bundle is started (before - * {@link #onSessionInitiated(ProviderContext)} so the Framework can perform + * {@link BindingAwareProvider#onSessionInitiated(ProviderContext)} so the Framework can perform * the bundle-specific activities necessary to start this bundle. This * method can be used to register services or to allocate any resources that * this bundle needs. @@ -88,7 +88,7 @@ public abstract class AbstractBrokerAwareActivator implements BundleActivator { * * @param context * The execution context of the bundle being started. - * @throws Exception + * @throws RuntimeException * If this method throws an exception, this bundle is marked as * stopped and the Framework will remove this bundle's * listeners, unregister all services registered by this bundle, @@ -110,7 +110,7 @@ public abstract class AbstractBrokerAwareActivator implements BundleActivator { * This method must complete and return to its caller in a timely manner. * * @param context The execution context of the bundle being stopped. - * @throws Exception If this method throws an exception, the bundle is still + * @throws RuntimeException If this method throws an exception, the bundle is still * marked as stopped, and the Framework will remove the bundle's * listeners, unregister all services registered by the bundle, and * release all services used by the bundle. diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java index 8ede7476b6..b934800d98 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java @@ -18,7 +18,7 @@ import org.osgi.framework.BundleContext; * Binding-aware core of the SAL layer responsible for wiring the SAL consumers. * * The responsibility of the broker is to maintain registration of SAL - * functionality {@link Consumer}s and {@link Provider}s, store provider and + * functionality Consumers and Providers, store provider and * consumer specific context and functionality registration via * {@link ConsumerContext} and provide access to infrastructure services, which * removes direct dependencies between providers and consumers. @@ -68,9 +68,9 @@ public interface BindingAwareBroker { * The consumer is required to use returned session for all communication * with broker or one of the broker services. The session is announced to * the consumer by invoking - * {@link Consumer#onSessionInitiated(ConsumerContext)}. + * {@link BindingAwareConsumer#onSessionInitialized(ConsumerContext)}. * - * @param cons + * @param consumer * Consumer to be registered. * @return a session specific to consumer registration * @throws IllegalArgumentException @@ -92,7 +92,7 @@ public interface BindingAwareBroker { *

    * During the registration, the broker obtains the initial functionality * from consumer, using the - * {@link BindingAwareProvider#getImplementations()}, and register that + * BindingAwareProvider#getImplementations(), and register that * functionality into system and concrete infrastructure services. * *

    @@ -106,7 +106,7 @@ public interface BindingAwareBroker { * {@link BindingAwareProvider#onSessionInitiated(ProviderContext)}. * * - * @param prov + * @param provider * Provider to be registered. * @return a session unique to the provider registration. * @throws IllegalArgumentException @@ -127,7 +127,7 @@ public interface BindingAwareBroker { * The session serves to store SAL context (e.g. registration of * functionality) for the consumer and provides access to the SAL * infrastructure services and other functionality provided by - * {@link Provider}s. + * {@link BindingAwareProvider}s. */ interface ConsumerContext extends RpcConsumerRegistry { @@ -192,7 +192,7 @@ public interface BindingAwareBroker { * Register particular instance identifier to be processed by this * RpcService * - * Deprecated in favor of {@link RoutedRegistration#registerPath(Object, Object)}. + * Deprecated in favor of RoutedRegistration#registerPath(Object, Object). * * @param context * @param instance @@ -204,7 +204,7 @@ public interface BindingAwareBroker { * Unregister particular instance identifier to be processed by this * RpcService * - * Deprecated in favor of {@link RoutedRegistration#unregisterPath(Object, Object)}. + * Deprecated in favor of RoutedRegistration#unregisterPath(Class, InstanceIdentifier). * * @param context * @param instance diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.java index bcbd6879d0..b3b3e07b5e 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.java @@ -64,9 +64,6 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerCo * DataBroker databroker = session.getSALService(BindingDataBroker.class); * } * } -* @see org.opendaylight.controller.md.sal.common.api.data.BindingDataBroker -* for more info on using the DataBroker. -* */ public interface BindingAwareConsumer { diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.java index 35583c0d42..808863262d 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.java @@ -45,27 +45,28 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderCo * * To get a NotificationService: * - * {code + * {@code * public void onSessionInitiated(ProviderContext session) { * NotificationProviderService notificationService = session.getSALService(NotificationProviderService.class); * } + * } * For more information on sending notifications via the NotificationProviderService * @see org.opendaylight.controller.sal.binding.api.NotificationProviderService * * To register an RPC implementation: * - * {code + * {@code * public void onSessionInitiated(ProviderContext session) { * RpcRegistration registration = session.addRpcImplementation(MyService.class, myImplementationInstance); * } + * } * *

    - * * Where MyService.class is a Service interface generated from a yang model with RPCs modeled in it and myImplementationInstance * is an instance of a class that implements MyService. * * To register a Routed RPC Implementation: - * {code + * {@code * public void onSessionInitiated(ProviderContext session) { * RoutedRpcRegistration flowRegistration = session.addRoutedRpcImplementation(SalFlowService.class, salFlowServiceImplementationInstance); flowRegistration.registerPath(NodeContext.class, nodeInstanceId); @@ -76,7 +77,7 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderCo * of a class that implements SalFlowService. *

    * The line: - * {code + * {@code * flowRegistration.registerPath(NodeContext.class, nodeInstanceId); * } * Is indicating that the RPC implementation is registered to handle RPC invocations that have their NodeContext pointing to the node with instance id nodeInstanceId. @@ -92,14 +93,11 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderCo * * To get a DataBroker to allow access to the data tree: * - * {code + * {@code * public void onSessionInitiated(final ProviderContext session) { * DataBroker databroker = session.getSALService(BindingDataBroker.class); * } * } - * @see org.opendaylight.controller.md.sal.common.api.data.BindingDataBroker - * for more info on using the DataBroker. - * */ public interface BindingAwareProvider { diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java index dd66aa67f8..015988e3d9 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java @@ -20,6 +20,7 @@ import org.opendaylight.yangtools.yang.binding.Notification; *

  • Dispatch listener - listener, which implements {ModelName}Listener interface, * which has dispatch methods for each defined notification. Methods are invoked based on notification type (class). *
  • + *
* *

Generic Listener

*

@@ -47,11 +48,11 @@ import org.opendaylight.yangtools.yang.binding.Notification; * are registered using {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)} * method. * - *

Dispatch Listener Example
+ *

Dispatch Listener Example

*

* Lets assume we have following YANG model: * - *

+ * {@code
  * module example {
  *      ...
  *
@@ -63,17 +64,17 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  *           ...
  *      }
  * }
- * 
+ * } * * The generated interface will be: - *
+ * {@code
  *  public interface ExampleListener extends NotificationListener {
  *      void onStart(Start notification);
  *      void onStop(Stop notification);
  *  }
- * 
+ * } * The following defines an implementation of the generated interface: - *
+ * {@code
  *  public class MyExampleListener implements ExampleListener {
  *      public void onStart(Start notification) {
  *          // do something
@@ -83,12 +84,12 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  *          // do something
  *      }
  *  }
- * 
+ * } * The implementation is registered as follows: - *
+ * {@code
  *  MyExampleListener listener = new MyExampleListener();
  *  ListenerRegistration reg = service.registerNotificationListener( listener );
- * 
+ * } * The onStart method will be invoked when someone publishes a Start notification and * the onStop method will be invoked when someone publishes a Stop notification. * diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java index 0c5e7649f8..d31a2fe327 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java @@ -49,7 +49,7 @@ public interface RpcConsumerRegistry extends BindingAwareService, BindingService * to listen for Rpc Result. This will asynchronously listen for future result in executor and * will not block current thread. * - *
+     * {@code
      *   final Future> future = someRpcService.someRpc( ... );
      *   Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future), new FutureCallback>() {
      *
@@ -61,7 +61,9 @@ public interface RpcConsumerRegistry extends BindingAwareService, BindingService
      *          // RPC failed
      *       }
      *   );
-     * 
+ * } + * } + * * @param serviceInterface the interface of the RPC Service. Typically this is an interface generated * from a YANG model. * @return the proxy for the requested RPC service. This method never returns null. diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java index 22db985ba9..759dbe01a7 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java @@ -68,11 +68,11 @@ import org.opendaylight.yangtools.yang.binding.RpcService; * *

Routed RPC example

*

- *

1. Defining a Context Type
+ *

1. Defining a Context Type

*

* The following snippet declares a simple YANG identity named example-context: * - *

+ * {@code
  * module example {
  *     ...
  *     identity example-context {
@@ -80,7 +80,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  *     }
  *     ...
  * }
- * 
+ * } *

* We then use the declared identity to define a context type by using it in combination * with the context-instance YANG extension. We'll associate the context type @@ -90,7 +90,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService; * The following YANG snippet imports the yang-ext module and defines the list * element named item inside a container named foo: * - *

+ * {@code
  * module foo {
  *     ...
  *     import yang-ext {prefix ext;}
@@ -104,7 +104,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  *     }
  *     ...
  * }
- * 
+ * } *

* The statement ext:context-instance "example-context"; inside the list element * declares that any instance identifier referencing item in the data @@ -257,7 +257,7 @@ public interface RpcProviderRegistry extends // * @param serviceInterface the YANG-generated interface of the RPC Service for which to register. * @param implementation the implementation instance to register. * @return a RoutedRpcRegistration instance which can be used to register paths for the RPC - * implementation via invoking {@link RoutedRpcRegistration#registerPath(....). + * implementation via invoking RoutedRpcRegistration#registerPath(Class, InstanceIdentifer). * {@link RoutedRpcRegistration#close()} should be called to unregister the implementation * and all previously registered paths when no longer needed. * diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java index d1f9d3eafe..47855da301 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java @@ -29,10 +29,10 @@ public interface DataBrokerService extends BindingAwareService, * * @return new blank data modification transaction. * @deprecated Replaced by more specific transaction types. Please use - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(), - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction() + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()}, + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()} * or - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction(). + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}. */ @Deprecated DataModificationTransaction beginTransaction(); diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java index b769812f2b..7e72bd488f 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java @@ -17,15 +17,11 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; import org.opendaylight.yangtools.yang.common.RpcResult; /** - * - * * @deprecated Replaced by more specific transaction types. Please use - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(), - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction() + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()}, + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()} * or - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction(). - * - * + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}. */ @Deprecated public interface DataModificationTransaction extends @@ -41,7 +37,7 @@ public interface DataModificationTransaction extends * Initiates a two-phase commit of candidate data. * *

- * The {@link Consumer} could initiate a commit of candidate data + * The Consumer could initiate a commit of candidate data * *

* The successful commit changes the state of the system and may affect @@ -49,15 +45,11 @@ public interface DataModificationTransaction extends * *

* The effects of successful commit of data are described in the - * specifications and YANG models describing the {@link Provider} components - * of controller. It is assumed that {@link Consumer} has an understanding + * specifications and YANG models describing the Provider components + * of controller. It is assumed that the Consumer has an understanding * of this changes. * * - * @see org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler for further information how two-phase commit is - * processed. - * @param store - * Identifier of the store, where commit should occur. * @return Result of the commit, containing success information or list of * encountered errors, if commit was not successful. */ diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/SynchronizedTransaction.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/SynchronizedTransaction.java index fc0d3964ea..cc3ee4b26f 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/SynchronizedTransaction.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/SynchronizedTransaction.java @@ -26,10 +26,10 @@ import com.google.common.base.Preconditions; * To get instance of synchronized wrapper use {@link #from(DataModificationTransaction)} * * @deprecated Replaced by more specific transaction types. Please use - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(), - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction() + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()}, + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()} * or - * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction(). + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}. * */ @Deprecated diff --git a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MessageTracker.java b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MessageTracker.java index 326430922c..65cef56a2b 100644 --- a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MessageTracker.java +++ b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MessageTracker.java @@ -29,7 +29,7 @@ import org.slf4j.LoggerFactory; * expected to arrive in a given time interval does not arrive. It attempts to keep track of all the messages that * received between the arrival of two instances of the same message and the amount of time it took to process each * of those messages. - *
+ *
* Usage of the API is as follows, *

  *
diff --git a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MeteringBehavior.java b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MeteringBehavior.java
index 5e631b90d3..523417ec76 100644
--- a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MeteringBehavior.java
+++ b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MeteringBehavior.java
@@ -17,7 +17,8 @@ import org.opendaylight.controller.cluster.reporting.MetricsReporter;
 
 /**
  * Represents behaviour that can be exhibited by actors of type {@link akka.actor.UntypedActor}
- * 

+ * + *

* This behaviour meters actor's default behaviour. It captures 2 metrics: *

    *
  • message processing rate of actor's receive block
  • @@ -70,11 +71,13 @@ public class MeteringBehavior implements Procedure { /** * Uses 2 timers to measure message processing rate. One for overall message processing rate and * another to measure rate by message type. The timers are re-used if they were previously created. - *

    + * + *

    * {@link com.codahale.metrics.MetricRegistry} maintains a reservoir for different timers where * collected timings are kept. It exposes various metrics for each timer based on collected * data. Eg: count of messages, 99, 95, 50... percentiles, max, mean etc. - *

    + * + *

    * These metrics are exposed as JMX bean. * * @see diff --git a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/UnifiedConfig.java b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/UnifiedConfig.java index 198ddf7ca8..d14f3a7f33 100644 --- a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/UnifiedConfig.java +++ b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/UnifiedConfig.java @@ -11,7 +11,8 @@ import com.typesafe.config.Config; /** * Represents a unified view of configuration. - *

    + * + *

    * It merges configuration from: *

    * + * * @param request * Commit Request submitted by client, which contains * information about modifications and read-only view as diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java index 8265fc4057..2af9f055f9 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java @@ -97,8 +97,7 @@ public interface AsyncDataBroker

    , D, L extends AsyncDataChange * * * - * @see http://www.idevelopment.info/data/LDAP/LDAP_Resources/ - * SEARCH_Setting_the_SCOPE_Parameter.shtml + * @see LDAP */ enum DataChangeScope { diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataChangeListener.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataChangeListener.java index 53194b372b..a7a9fef07f 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataChangeListener.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataChangeListener.java @@ -43,8 +43,10 @@ public interface AsyncDataChangeListener

    , D> extends EventList * *

    * Note: This method may be invoked from a shared thread pool. + *

      *
    • Implementations SHOULD NOT perform CPU-intensive operations on the calling thread. *
    • Implementations MUST NOT block the calling thread - to do so could lead to deadlock + *
    * scenarios. * *
    diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadTransaction.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadTransaction.java index afa86704ff..053d6346a4 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadTransaction.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadTransaction.java @@ -55,9 +55,6 @@ import org.opendaylight.yangtools.concepts.Path; * tree * @param * Type of data (payload), which represents data payload - * - * @see org.opendaylight.controller.md.sal.binding.api.ReadTransaction - * @see org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction */ public interface AsyncReadTransaction

    , D> extends AsyncTransaction { diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java index e47b54a0a1..cc22bb91ad 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java @@ -132,8 +132,6 @@ public interface AsyncWriteTransaction

    , D> extends AsyncTransa *

    * This call logically seals the transaction, which prevents the client from * further changing data tree using this transaction. Any subsequent calls to - * {@link #put(LogicalDatastoreType, Path, Object)}, - * {@link #merge(LogicalDatastoreType, Path, Object)} or * {@link #delete(LogicalDatastoreType, Path)} will fail with * {@link IllegalStateException}. * @@ -149,24 +147,24 @@ public interface AsyncWriteTransaction

    , D> extends AsyncTransa * The effects of a successful commit of data depends on data change listeners * ({@link AsyncDataChangeListener}) and commit participants * ({@link AsyncConfigurationCommitHandler}) that are registered with the data broker. - *

    + * *

    Example usage:

    *
          *  private void doWrite( final int tries ) {
          *      WriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
          *
          *      MyDataObject data = ...;
    -     *      InstanceIdentifier path = ...;
    +     *      InstanceIdentifier<MyDataObject> path = ...;
          *      writeTx.put( LogicalDatastoreType.OPERATIONAL, path, data );
          *
    -     *      Futures.addCallback( writeTx.submit(), new FutureCallback() {
    +     *      Futures.addCallback( writeTx.submit(), new FutureCallback<Void>() {
          *          public void onSuccess( Void result ) {
          *              // succeeded
          *          }
          *
          *          public void onFailure( Throwable t ) {
          *              if( t instanceof OptimisticLockFailedException ) {
    -     *                  if( ( tries - 1 ) > 0 ) {
    +     *                  if( ( tries - 1 ) < 0 ) {
          *                      // do retry
          *                      doWrite( tries - 1 );
          *                  } else {
    @@ -214,7 +212,7 @@ public interface AsyncWriteTransaction

    , D> extends AsyncTransa * which are based on same initial state, Tx 1 completes successfully * before Tx 2 is submitted. * - * + *
    * * * @@ -238,7 +236,7 @@ public interface AsyncWriteTransaction

    , D> extends AsyncTransa * which are based on same initial state, Tx 1 completes successfully * before Tx 2 is submitted. * - *

    Initial stateTx 1Tx 2Result
    Emptyput(A,1)put(A,2)Tx 2 will fail, state is A=1
    Emptyput(A,1)merge(A,2)A=2
    + *
    * * * diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataModification.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataModification.java index f90098c959..5356c56d8a 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataModification.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataModification.java @@ -85,11 +85,6 @@ public interface DataModification

    , D> extends DataChange * controller. It is assumed that Consumer has an understanding of this * changes. * - * - * @see DataCommitHandler for further information how two-phase commit is - * processed. - * @param store - * Identifier of the store, where commit should occur. * @return Result of the Commit, containing success information or list of * encountered errors, if commit was not successful. The Future * blocks until {@link TransactionStatus#COMMITED} or diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java index 11f28039be..12d9da696e 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java @@ -26,7 +26,7 @@ import org.opendaylight.yangtools.concepts.Path; * t1.submit(); * * AsyncReadTransaction t2 = broker.newReadOnlyTransaction(); - * Optional maybeData = t2.read(id).get(); + * Optional<?> maybeData = t2.read(id).get(); * * it may happen, that it sees maybeData.isPresent() == false, simply because * t1 has not completed the processes of being applied and t2 is actually diff --git a/opendaylight/md-sal/sal-common-util/src/main/java/org/opendaylight/controller/md/sal/common/util/jmx/QueuedNotificationManagerMXBean.java b/opendaylight/md-sal/sal-common-util/src/main/java/org/opendaylight/controller/md/sal/common/util/jmx/QueuedNotificationManagerMXBean.java index 9646adc773..dd89e00678 100644 --- a/opendaylight/md-sal/sal-common-util/src/main/java/org/opendaylight/controller/md/sal/common/util/jmx/QueuedNotificationManagerMXBean.java +++ b/opendaylight/md-sal/sal-common-util/src/main/java/org/opendaylight/controller/md/sal/common/util/jmx/QueuedNotificationManagerMXBean.java @@ -13,7 +13,7 @@ import java.util.List; import org.opendaylight.yangtools.util.concurrent.ListenerNotificationQueueStats; /** - * MXBean interface for {@link QueuedNotificationManager} statistic metrics. + * MXBean interface for {@link org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager} statistic metrics. * * @author Thomas Pantelis */ diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataChangeListener.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataChangeListener.java index e1f2777373..cee7344577 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataChangeListener.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataChangeListener.java @@ -25,7 +25,7 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; /** * Actor for a DataChangeListener. * - * @Deprecated Replaced by {@link DataTreeChangeListener} + * @deprecated Replaced by {@link DataTreeChangeListener} */ @Deprecated public class DataChangeListener extends AbstractUntypedActor { diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java index 4a1be9862b..26f18bd932 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java @@ -93,7 +93,8 @@ import scala.concurrent.duration.FiniteDuration; /** * A Shard represents a portion of the logical data tree. - *

    + * + *

    * Our Shard uses InMemoryDataTree as it's internal representation and delegates all requests it */ public class Shard extends RaftActor { diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardDataTree.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardDataTree.java index ef6436ae8d..f18271ae36 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardDataTree.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardDataTree.java @@ -77,7 +77,8 @@ import scala.concurrent.duration.Duration; * Internal shard state, similar to a DOMStore, but optimized for use in the actor system, * e.g. it does not expose public interfaces and assumes it is only ever called from a * single thread. - *

    + * + *

    * This class is not part of the API contract and is subject to change at any time. */ @NotThreadSafe diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java index 1e23120f0b..b62b056d58 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java @@ -32,7 +32,8 @@ interface TransactionContext { * Invoked by {@link TransactionContextWrapper} when it has finished handing * off operations to this context. From this point on, the context is responsible * for throttling operations. - *

    + * + *

    * Implementations can rely on the wrapper calling this operation in a synchronized * block, so they do not need to ensure visibility of this state transition themselves. */ diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionReadyReplyMapper.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionReadyReplyMapper.java index 986cca5f3d..d1774980bf 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionReadyReplyMapper.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionReadyReplyMapper.java @@ -20,7 +20,8 @@ import scala.concurrent.Future; /** * A {@link Mapper} extracting the {@link ActorSelection} pointing to the actor which * is backing a particular transaction. - *

    + * + *

    * This class is not for general consumption. It is public only to support the pre-lithium compatibility * package. * TODO: once we remove compatibility, make this class package-private and final. diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/DataTreeChanged.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/DataTreeChanged.java index 919f9448a9..ff2c89c8dd 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/DataTreeChanged.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/DataTreeChanged.java @@ -14,8 +14,8 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate; /** * A message about a DataTree having been changed. The message is not * serializable on purpose. For delegating the change across cluster nodes, - * this needs to be intercepted by a local agent and forwarded as - * a {@link DataTreeDelta}. + * this needs to be intercepted by a local agent and forwarded as reconstructed + * candidate. */ public final class DataTreeChanged { private final Collection changes; diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/FindLocalShard.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/FindLocalShard.java index 380e71e78a..0179d8e0c5 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/FindLocalShard.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/FindLocalShard.java @@ -10,14 +10,14 @@ package org.opendaylight.controller.cluster.datastore.messages; /** * FindLocalShard is a message that should be sent to the - * {@link org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager} when we need to find a reference + * org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager when we need to find a reference * to a LocalShard. */ public class FindLocalShard { private final String shardName; private final boolean waitUntilInitialized; - public FindLocalShard(String shardName, boolean waitUntilInitialized) { + public FindLocalShard(final String shardName, final boolean waitUntilInitialized) { this.shardName = shardName; this.waitUntilInitialized = waitUntilInitialized; } diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardFound.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardFound.java index 5c58a894db..9e546f8974 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardFound.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardFound.java @@ -12,13 +12,13 @@ import akka.actor.ActorRef; /** * LocalShardFound is a message that is sent by the - * {@link org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager} + * org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager * when it finds a shard with the specified name in it's local shard registry. */ public class LocalShardFound { private final ActorRef path; - public LocalShardFound(ActorRef path) { + public LocalShardFound(final ActorRef path) { this.path = path; } diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardNotFound.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardNotFound.java index 381eb56231..47ec16991a 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardNotFound.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardNotFound.java @@ -10,7 +10,7 @@ package org.opendaylight.controller.cluster.datastore.messages; /** * LocalShardNotFound is a message that is sent by the - * {@link org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager} + * org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager * when it cannot locate a shard in it's local registry with the shardName specified. */ public class LocalShardNotFound { @@ -21,7 +21,7 @@ public class LocalShardNotFound { * * @param shardName the name of the shard that could not be found */ - public LocalShardNotFound(String shardName) { + public LocalShardNotFound(final String shardName) { this.shardName = shardName; } diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/Modification.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/Modification.java index 97b5e745df..a04fbd0719 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/Modification.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/Modification.java @@ -14,18 +14,19 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification /** * Represents a modification to the data store. + * *

    * Simple modifications can be of type, + *

      *
    • {@link org.opendaylight.controller.cluster.datastore.modification.WriteModification} *
    • {@link org.opendaylight.controller.cluster.datastore.modification.MergeModification} *
    • {@link org.opendaylight.controller.cluster.datastore.modification.DeleteModification} - *

      + *
    * *

    * Modifications can in turn be lumped into a single * {@link org.opendaylight.controller.cluster.datastore.modification.CompositeModification} * which can then be applied to a write transaction. - *

    */ public interface Modification extends Externalizable { diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/PayloadVersion.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/PayloadVersion.java index 0f52dacc5b..1dbbcba2e5 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/PayloadVersion.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/PayloadVersion.java @@ -19,9 +19,12 @@ import org.opendaylight.yangtools.concepts.WritableObject; /** * Enumeration of all ABI versions supported by this implementation of persistence. An ABI version has to be bumped * whenever: - * - a new event is defined - * - serialization format is changed - *

    + *

      + *
    • a new event is defined
    • + *
    • serialization format is changed
    • + *
    + * + *

    * This version effectively defines the protocol version between actors participating on a particular shard. A shard * participant instance should oppose RAFT candidates which produce persistence of an unsupported version. If a follower * encounters an unsupported version it must not become fully-operational, as it does not have an accurate view diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/ShardDataTreeSnapshotMetadata.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/ShardDataTreeSnapshotMetadata.java index 25cfda0177..0ddc785a90 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/ShardDataTreeSnapshotMetadata.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/ShardDataTreeSnapshotMetadata.java @@ -17,11 +17,13 @@ import javax.annotation.Nonnull; * an interface because we want to make sure all subclasses implement the externalizable proxy pattern, for which * we need to force {@link #writeReplace()} to be abstract. We do that by making it final and exposing a protected * {@link #externalizableProxy()} method. - *

    + * + *

    * All concrete subclasses of this class should be final so as to form a distinct set of possible metadata. Since * metadata is serialized along with {@link MetadataShardDataTreeSnapshot}, this set is part of the serialization format * guarded by {@link PayloadVersion}. - *

    + * + *

    * If a new metadata type is introduced or a type is removed, {@link PayloadVersion} needs to be bumped to ensure * compatibility. * diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java index 0440b7f023..496069d0a1 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java @@ -16,7 +16,8 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; public interface ShardStrategy { /** * Find the name of the shard in which the data pointed to by the specified path belongs in. - *

    + * + *

    * Should return the name of the default shard DefaultShardStrategy.DEFAULT_SHARD * if no matching shard was found * diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java index 083cd10ef3..7392b15345 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java @@ -36,7 +36,7 @@ public interface DOMDataTreeListener extends EventListener { * a connection to external subtree source is broken. The listener will not receive any other * callbacks, but its registration still needs to be closed to prevent resource leak. * - * @param cause Collection of failure causes, may not be null or empty. + * @param causes Collection of failure causes, may not be null or empty. */ void onDataTreeFailed(@Nonnull Collection causes); } diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java index cbfa0122f2..48f47d181d 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java @@ -44,14 +44,14 @@ public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoClo * previously allocated must have been either submitted or cancelled by the * time this method is invoked. * - * @param barrier Indicates whether this transaction should be a barrier. A barrier + * @param isolated Indicates whether this transaction should be a barrier. A barrier * transaction is processed separately from any preceding transactions. * Non-barrier transactions may be merged and processed in a batch, * such that any observers see the modifications contained in them as * if the modifications were made in a single transaction. * @return A new {@link DOMDataWriteTransaction} - * @throws {@link IllegalStateException} if a previous transaction was not closed. - * @throws {@link IllegalThreadStateException} if the calling thread context does not + * @throws IllegalStateException if a previous transaction was not closed. + * @throws IllegalThreadStateException if the calling thread context does not * match the lifecycle rules enforced by the producer state (e.g. bound or unbound). * This exception is thrown on a best effort basis and programs should not rely * on it for correct operation. @@ -73,10 +73,10 @@ public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoClo * Once this method returns successfully, this (parent) producer loses the ability to * access the specified paths until the resulting (child) producer is shut down. * - * @throws {@link IllegalStateException} if there is an open transaction - * @throws {@link IllegalArgumentException} if subtrees contains a subtree which is not + * @throws IllegalStateException if there is an open transaction + * @throws IllegalArgumentException if subtrees contains a subtree which is not * accessible by this producer - * @throws {@link IllegalThreadStateException} if the calling thread context does not + * @throws IllegalThreadStateException if the calling thread context does not * match the lifecycle rules enforced by the producer state (e.g. bound or unbound). * This exception is thrown on a best effort basis and programs should not rely * on it for correct operation. diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java index 89ac8d1e6c..46726da421 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java @@ -20,7 +20,7 @@ public interface DOMDataTreeProducerFactory { * * @param subtrees The collection of subtrees the resulting producer should have access to. * @return A {@link DOMDataTreeProducer} instance. - * @throws {@link IllegalArgumentException} if subtrees is empty. + * @throws IllegalArgumentException if subtrees is empty. */ @Nonnull DOMDataTreeProducer createProducer(@Nonnull Collection subtrees); } diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java index 21ff44c539..bb4d54720a 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java @@ -58,5 +58,5 @@ public interface DOMDataTreeService extends DOMDataTreeProducerFactory, DOMServi * feedback loop */ @Nonnull ListenerRegistration registerListener(@Nonnull T listener, - @Nonnull Collection subtrees, boolean allowRxMerges, @Nonnull Collection producers); + @Nonnull Collection subtrees, boolean allowRxMerges, @Nonnull Collection producers) throws DOMDataTreeLoopException; } diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataWriteTransaction.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataWriteTransaction.java index b8fe26387b..76999ec5d4 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataWriteTransaction.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataWriteTransaction.java @@ -19,6 +19,9 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; */ public interface DOMDataWriteTransaction extends AsyncWriteTransaction> { + @Override + void delete(LogicalDatastoreType store, YangInstanceIdentifier path); + /** * Stores a piece of data at the specified path. This acts as an add / replace * operation, which is to say that whole subtree will be replaced by the specified data. diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMExtensibleService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMExtensibleService.java index 22334420ad..7e9d56e1c8 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMExtensibleService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMExtensibleService.java @@ -16,8 +16,8 @@ import javax.annotation.Nonnull; * Aside for marking these, they also provide runtime query to detect whether * a particular trait is in fact available. * - * Base {@link DOMService} - * Extension type + * @param Base {@link DOMService} + * @param Extension type */ @Beta public interface DOMExtensibleService, E extends DOMServiceExtension> extends DOMService { diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java index b4df6b4564..f80a124a8d 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java @@ -41,12 +41,15 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService * Abstract subclasses can refine the return type as returning a promise of a * more specific type, e.g.: * + * {@code * public interface DeliveryStatus { int getListenerCount(); } * ListenableFuture putNotification(DOMNotification notification); + * } * * Once the Future succeeds, the resulting object can be queried for traits using * instanceof, e.g: * + * {@code * // Can block when (for example) the implemention's ThreadPool queue is full * Object o = service.putNotification(notif).get(); * if (o instanceof DeliveryStatus) { @@ -83,7 +86,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService * @param notification Notification to be published. * @return A listenable future which will report completion when the service * has finished propagating the notification to its immediate registrants, - * or {@value #REJECTED} if resource constraints prevent + * or {@link #REJECTED} if resource constraints prevent * the implementation from accepting the notification for delivery. * @throws NullPointerException if notification is null. */ @@ -102,7 +105,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService * @param unit a TimeUnit determining how to interpret the timeout parameter * @return A listenable future which will report completion when the service * has finished propagating the notification to its immediate registrants, - * or {@value #REJECTED} if resource constraints prevent + * or {@link #REJECTED} if resource constraints prevent * the implementation from accepting the notification for delivery. * @throws InterruptedException if interrupted while waiting * @throws NullPointerException if notification or unit is null. diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationRejectedException.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationRejectedException.java index 4d0aa665ea..b57b5053d5 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationRejectedException.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationRejectedException.java @@ -11,10 +11,9 @@ package org.opendaylight.controller.md.sal.dom.api; *

    * This exception indicates that given notification can not be processed by corresponding mechanism. * More info can be provided in message. - *

    + * *

    * Expected use: {@link DOMNotificationPublishService} - *

    */ public class DOMNotificationRejectedException extends Exception { private static final long serialVersionUID = 1L; diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationService.java index 036ea24cb1..33f009a91f 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationService.java @@ -26,7 +26,7 @@ public interface DOMNotificationService extends DOMService, BrokerService { * @param listener Notification instance to register * @param types Notification types which should be delivered to the listener. Duplicate * entries are processed only once, null entries are ignored. - * @return Registration handle. Invoking {@link DOMNotificationListenerRegistration#close()} + * @return Registration handle. Invoking {@link ListenerRegistration#close()} * will stop the delivery of notifications to the listener * @throws IllegalArgumentException if types is empty or contains an invalid element, such as * null or a SchemaPath which does not represent a valid {@link DOMNotification} type. @@ -42,7 +42,7 @@ public interface DOMNotificationService extends DOMService, BrokerService { * @param listener Notification instance to register * @param types Notification types which should be delivered to the listener. Duplicate * entries are processed only once, null entries are ignored. - * @return Registration handle. Invoking {@link DOMNotificationListenerRegistration#close()} + * @return Registration handle. Invoking {@link ListenerRegistration#close()} * will stop the delivery of notifications to the listener * @throws IllegalArgumentException if types is empty or contains an invalid element, such as * null or a SchemaPath which does not represent a valid {@link DOMNotification} type. diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java index 48f6ab6500..e0c95a197b 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java @@ -44,8 +44,8 @@ public interface DOMRpcService extends DOMService { * to prevent this scenario from occurring. * * @param listener {@link DOMRpcAvailabilityListener} instance to register - * @return A {@link DOMRpcAvailabilityListenerRegistration} representing this registration. Performing - * a {@link DOMRpcAvailabilityListenerRegistration#close()} will cancel it. Returned object + * @return A {@link ListenerRegistration} representing this registration. Performing + * a {@link ListenerRegistration#close()} will cancel it. Returned object * is guaranteed to be non-null. */ @Nonnull ListenerRegistration registerRpcListener(@Nonnull T listener); diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java index f0c4be2669..b5c39779ab 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java @@ -41,7 +41,7 @@ public interface Consumer { * @deprecated - no longer used or needed * * * Suggested implementation until removed: - * @code { + * {@code * public Collection getConsumerFunctionality() { * return Collections.emptySet(); * } diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java index 4895d10ac8..ea6f69c331 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java @@ -45,7 +45,7 @@ public interface Provider { * @deprecated - No longer used or needed * * Suggested implementation until removed: - * @code { + * {@code * public Collection getProviderFunctionality() { * return Collections.emptySet(); * } diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/AbstractDOMForwardedTransactionFactory.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/AbstractDOMForwardedTransactionFactory.java index fef26fe603..8dde797081 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/AbstractDOMForwardedTransactionFactory.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/AbstractDOMForwardedTransactionFactory.java @@ -17,6 +17,7 @@ import java.util.concurrent.atomic.AtomicIntegerFieldUpdater; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction; +import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction; import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction; import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction; import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction; @@ -88,7 +89,7 @@ abstract class AbstractDOMForwardedTransactionFactory * Implementation of composite Write-only transaction is following: * - *
      - *
    • - * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + *
      • + * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * - backing subtransaction is selected by {@link LogicalDatastoreType}, - * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * is invoked on selected subtransaction. - *
      • - * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + *
      • + * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * - backing subtransaction is selected by {@link LogicalDatastoreType}, - * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * is invoked on selected subtransaction. - *
      • - * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier) + *
      • + * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} * - backing subtransaction is selected by {@link LogicalDatastoreType}, - * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on + * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} is invoked on * selected subtransaction. - *
      • {@link DOMDataWriteTransaction#commit()} - results in invoking + *
      • {@link DOMDataWriteTransaction#commit()} - results in invoking * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts * and then invoking finalized implementation callback - * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which + * {@link #submit(DOMDataWriteTransaction, Collection)} with transaction which * was commited and gathered results. + *
      • *
      * * Id of returned transaction is generated via @@ -166,30 +167,30 @@ abstract class AbstractDOMForwardedTransactionFactory *
    • - * {@link DOMDataWriteTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} + * {@link DOMDataReadTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} * - backing subtransaction is selected by {@link LogicalDatastoreType}, - * {@link DOMStoreWriteTransaction#read(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on + * {@link DOMStoreReadTransaction#read(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} is invoked on * selected subtransaction. *
    • - * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * - backing subtransaction is selected by {@link LogicalDatastoreType}, - * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * is invoked on selected subtransaction. *
    • - * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * - backing subtransaction is selected by {@link LogicalDatastoreType}, - * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} + * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)} * is invoked on selected subtransaction. *
    • - * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier) + * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} * - backing subtransaction is selected by {@link LogicalDatastoreType}, - * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on + * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} is invoked on * selected subtransaction. *
    • {@link DOMDataWriteTransaction#commit()} - results in invoking * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts * and then invoking finalized implementation callback - * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which - * was commited and gathered results. + * {@link #submit(DOMDataWriteTransaction, Collection)} with transaction which + * was committed and gathered results. *
    • *
    * diff --git a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/AbstractDOMStoreTransaction.java b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/AbstractDOMStoreTransaction.java index 106abca3ec..fba643d8f9 100644 --- a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/AbstractDOMStoreTransaction.java +++ b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/AbstractDOMStoreTransaction.java @@ -22,7 +22,7 @@ import javax.annotation.Nullable; * * It can optionally capture the context where it was allocated. * - * identifier type + * @param identifier type */ @Beta public abstract class AbstractDOMStoreTransaction implements DOMStoreTransaction { diff --git a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreThreePhaseCommitCohort.java b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreThreePhaseCommitCohort.java index 986a153efb..ec54e42cd7 100644 --- a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreThreePhaseCommitCohort.java +++ b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreThreePhaseCommitCohort.java @@ -13,7 +13,7 @@ import com.google.common.util.concurrent.ListenableFuture; * Interface implemented by the {@link DOMStore} and exposed for each {@link DOMStoreWriteTransaction} * upon its transition to Ready state. The frontend (DOMStore user) uses this interface to drive the * commit procedure across potentially multiple DOMStores using the Three-Phase-Commit (3PC) Protocol, - * as described in {@link https://en.wikipedia.org/wiki/Three-phase_commit}. + * as described in Three-Phase-Commit Protocol. */ public interface DOMStoreThreePhaseCommitCohort { @@ -29,6 +29,7 @@ public interface DOMStoreThreePhaseCommitCohort { * true if transaction is approved by data store. *
  • false if the transaction is not approved by data store and * should be aborted. + * */ ListenableFuture canCommit(); diff --git a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreWriteTransaction.java b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreWriteTransaction.java index 0a090520f2..1964fd41bd 100644 --- a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreWriteTransaction.java +++ b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreWriteTransaction.java @@ -18,7 +18,7 @@ public interface DOMStoreWriteTransaction extends DOMStoreTransaction { * specified path. * * If you need add or merge of current object with specified use - * {@link #merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.concepts.Path, Object)} + * {@link #merge(YangInstanceIdentifier, NormalizedNode)}. * * * @param path @@ -36,10 +36,6 @@ public interface DOMStoreWriteTransaction extends DOMStoreTransaction { * operation, which is to say that whole subtree will be replaced by * specified path. * - * If you need add or merge of current object with specified use - * {@link #merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.concepts.Path, Object)} - * - * * @param path * @param data * Data object to be written diff --git a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedReadTransaction.java b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedReadTransaction.java index 8e5957c71a..1e68c61319 100644 --- a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedReadTransaction.java +++ b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedReadTransaction.java @@ -27,7 +27,7 @@ import org.slf4j.LoggerFactory; * Implementation of read-only transaction backed by {@link DataTreeSnapshot} * which delegates most of its calls to similar methods provided by underlying snapshot. * - * identifier type + * @param identifier type */ @Beta public final class SnapshotBackedReadTransaction extends AbstractDOMStoreTransaction implements DOMStoreReadTransaction { diff --git a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedWriteTransaction.java b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedWriteTransaction.java index a02d768370..dc600dd130 100644 --- a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedWriteTransaction.java +++ b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedWriteTransaction.java @@ -159,9 +159,6 @@ public class SnapshotBackedWriteTransaction extends AbstractDOMStoreTransacti } /** - * Prototype implementation of - * {@link #ready(org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction)} - * * This class is intended to be implemented by Transaction factories * responsible for allocation of {@link org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction} and * providing underlying logic for applying implementation. @@ -190,4 +187,4 @@ public class SnapshotBackedWriteTransaction extends AbstractDOMStoreTransacti */ protected abstract DOMStoreThreePhaseCommitCohort transactionReady(SnapshotBackedWriteTransaction tx, DataTreeModification tree); } -} \ No newline at end of file +} diff --git a/opendaylight/md-sal/sal-remoterpc-connector/pom.xml b/opendaylight/md-sal/sal-remoterpc-connector/pom.xml index 21e1634448..772d4461f0 100644 --- a/opendaylight/md-sal/sal-remoterpc-connector/pom.xml +++ b/opendaylight/md-sal/sal-remoterpc-connector/pom.xml @@ -207,27 +207,6 @@ - - - - jdk8 - - [1.8,) - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - - - scm:git:http://git.opendaylight.org/gerrit/controller.git scm:git:ssh://git.opendaylight.org:29418/controller.git diff --git a/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java b/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java index 7c5efc29e8..43f5dbcdc0 100644 --- a/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java +++ b/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java @@ -34,7 +34,8 @@ import scala.concurrent.duration.FiniteDuration; /** * Registry to look up cluster nodes that have registered for a given rpc. - *

    + * + *

    * It uses {@link org.opendaylight.controller.remote.rpc.registry.gossip.BucketStore} to maintain this * cluster wide information. */ diff --git a/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/gossip/Gossiper.java b/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/gossip/Gossiper.java index 9230591d46..439c131e3f 100644 --- a/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/gossip/Gossiper.java +++ b/opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/gossip/Gossiper.java @@ -44,19 +44,21 @@ import scala.concurrent.duration.FiniteDuration; /** * Gossiper that syncs bucket store across nodes in the cluster. - *

    + * + *

    * It keeps a local scheduler that periodically sends Gossip ticks to * itself to send bucket store's bucket versions to a randomly selected remote * gossiper. - *

    + * + *

    * When bucket versions are received from a remote gossiper, it is compared * with bucket store's bucket versions. Which ever buckets are newer * locally, are sent to remote gossiper. If any bucket is older in bucket store, * a gossip status is sent to remote gossiper so that it can send the newer buckets. - *

    + * + *

    * When a bucket is received from a remote gossiper, its sent to the bucket store * for update. - * */ public class Gossiper extends AbstractUntypedActorWithMetering { diff --git a/pom.xml b/pom.xml index 26c99151e2..58d1fd0923 100644 --- a/pom.xml +++ b/pom.xml @@ -46,26 +46,4 @@ HEAD https://wiki.opendaylight.org/view/OpenDaylight_Controller:Main - - - - - jdk8 - - [1.8,) - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - -Xdoclint:none - - - - - - -- 2.36.6

  • Initial stateTx 1Tx 2Result
    Emptyput(TOP,[])put(TOP,[])Tx 2 will fail, state is TOP=[]