GUAC-1132: Add missing @Override annotations.

This commit is contained in:
Michael Jumper
2015-03-17 15:29:22 -07:00
parent cd52b25b94
commit a345ee7385

View File

@@ -76,104 +76,54 @@ public class SynchronizedGuacamoleTunnel implements GuacamoleTunnel {
} }
/** @Override
* Acquires exclusive read access to the Guacamole instruction stream
* and returns a GuacamoleReader for reading from that stream.
*
* @return A GuacamoleReader for reading from the Guacamole instruction
* stream.
*/
public GuacamoleReader acquireReader() { public GuacamoleReader acquireReader() {
readerLock.lock(); readerLock.lock();
return socket.getReader(); return socket.getReader();
} }
/** @Override
* Relinquishes exclusive read access to the Guacamole instruction
* stream. This function should be called whenever a thread finishes using
* a GuacamoleTunnel's GuacamoleReader.
*/
public void releaseReader() { public void releaseReader() {
readerLock.unlock(); readerLock.unlock();
} }
/** @Override
* Returns whether there are threads waiting for read access to the
* Guacamole instruction stream.
*
* @return true if threads are waiting for read access the Guacamole
* instruction stream, false otherwise.
*/
public boolean hasQueuedReaderThreads() { public boolean hasQueuedReaderThreads() {
return readerLock.hasQueuedThreads(); return readerLock.hasQueuedThreads();
} }
/** @Override
* Acquires exclusive write access to the Guacamole instruction stream
* and returns a GuacamoleWriter for writing to that stream.
*
* @return A GuacamoleWriter for writing to the Guacamole instruction
* stream.
*/
public GuacamoleWriter acquireWriter() { public GuacamoleWriter acquireWriter() {
writerLock.lock(); writerLock.lock();
return socket.getWriter(); return socket.getWriter();
} }
/** @Override
* Relinquishes exclusive write access to the Guacamole instruction
* stream. This function should be called whenever a thread finishes using
* a GuacamoleTunnel's GuacamoleWriter.
*/
public void releaseWriter() { public void releaseWriter() {
writerLock.unlock(); writerLock.unlock();
} }
/** @Override
* Returns whether there are threads waiting for write access to the
* Guacamole instruction stream.
*
* @return true if threads are waiting for write access the Guacamole
* instruction stream, false otherwise.
*/
public boolean hasQueuedWriterThreads() { public boolean hasQueuedWriterThreads() {
return writerLock.hasQueuedThreads(); return writerLock.hasQueuedThreads();
} }
/** @Override
* Returns the unique identifier associated with this GuacamoleTunnel.
*
* @return The unique identifier associated with this GuacamoleTunnel.
*/
public UUID getUUID() { public UUID getUUID() {
return uuid; return uuid;
} }
/** @Override
* Returns the GuacamoleSocket used by this GuacamoleTunnel for reading
* and writing.
*
* @return The GuacamoleSocket used by this GuacamoleTunnel.
*/
public GuacamoleSocket getSocket() { public GuacamoleSocket getSocket() {
return socket; return socket;
} }
/** @Override
* Release all resources allocated to this GuacamoleTunnel.
*
* @throws GuacamoleException if an error occurs while releasing
* resources.
*/
public void close() throws GuacamoleException { public void close() throws GuacamoleException {
socket.close(); socket.close();
} }
/** @Override
* Returns whether this GuacamoleTunnel is open, or has been closed.
*
* @return true if this GuacamoleTunnel is open, false if it is closed.
*/
public boolean isOpen() { public boolean isOpen() {
return socket.isOpen(); return socket.isOpen();
} }