Java API: update JavaDoc to clarify asynchronous get operation's (25cc10db) · Commits · kinetic-archive / kinetic-java

kinetic-client/src/main/java/kinetic/client/KineticClient.java

+435 −428

Original line number	Diff line number	Diff line
		@@ -67,9 +67,11 @@ public interface KineticClient extends GenericKineticClient {
		public long noop() throws KineticException;

		/**
		* The flush operation flushes any outstanding PUTs or DELETEs on the device.
		* The flush operation flushes any outstanding PUTs or DELETEs on the
		* device.
		* <p>
		* Currently only Kinetic drive supports this operation. This command has no effect on the simulator.
		* Currently only Kinetic drive supports this operation. This command has no
		* effect on the simulator.
		*
		* @throws KineticException
		* if any internal error occurred.
		@@ -91,9 +93,9 @@ public interface KineticClient extends GenericKineticClient {
		* operation to determine the state of the previous unsuccessful put()
		* status.
		* <p>
		* Applications may force put the entry with {@link #putForced(Entry)} API. An
		* existed entry in the store is over-written if the key matches the entry
		* in the store.
		* Applications may force put the entry with {@link #putForced(Entry)} API.
		* An existed entry in the store is over-written if the key matches the
		* entry in the store.
		* <p>
		* Applications may use asynchronous put operation to put entry
		* asynchronously. The result of the asynchronous operation is delivered to
		@@ -110,7 +112,8 @@ public interface KineticClient extends GenericKineticClient {
		* the entry metadata is set to the new version.
		*
		* @throws VersionMismatchException
		* If the version in the specified entry does not match the version stored.
		* If the version in the specified entry does not match the
		* version stored.
		*
		* @throws KineticException
		* if any internal error occurred.
		@@ -121,8 +124,7 @@ public interface KineticClient extends GenericKineticClient {
		* @see CallbackHandler
		* @see CallbackResult
		*/
		public Entry put(Entry entry, byte[] newVersion)
		throws KineticException;
		public Entry put(Entry entry, byte[] newVersion) throws KineticException;

		/**
		* Put the specified <code>Entry</code> to the persistent store. Force to
		@@ -152,8 +154,8 @@ public interface KineticClient extends GenericKineticClient {
		/**
		* Put the versioned <code>Entry</code> asynchronously. If the version in
		* the specified entry does not match the version stored in the persistent
		* store, a <code>VersionMismatchException</code> is delivered to the callback
		* instance.
		* store, a <code>VersionMismatchException</code> is delivered to the
		* callback instance.
		*
		* @param entry
		* the <code>Entry</code> to be put to the persistent store.
		@@ -192,7 +194,6 @@ public interface KineticClient extends GenericKineticClient {
		public void putForcedAsync(Entry entry, CallbackHandler<Entry> handler)
		throws KineticException;


		/**
		* Get the <code>Entry</code> entry associated with the specified key.
		* <p>
		@@ -216,6 +217,13 @@ public interface KineticClient extends GenericKineticClient {
		/**
		* Get the <code>Entry</code> associated with the specified key
		* asynchronously.
		* <p>
		* If there is no entry found for an asynchronous get operation, the
		* callback handler's onSuccess method is invoked.
		* <p>
		* In this scenario (entry not found), calling CallbackResult.getResult()
		* will return null. This behavior is consistent with the synchronous
		* {@link #get(byte[])} operation.
		*
		* @param key
		* the key used to obtain the entry.
		@@ -453,8 +461,7 @@ public interface KineticClient extends GenericKineticClient {
		*/
		public void getKeyRangeAsync(byte[] startKey, boolean startKeyInclusive,
		byte[] endKey, boolean endKeyInclusive, int maxKeys,
		CallbackHandler<List<byte[]>> handler)
		throws KineticException;
		CallbackHandler<List<byte[]>> handler) throws KineticException;

		/**
		* Get entry metadata for the specified key.