safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 05:07:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

GUAC-1193: Document possibility of side effects when using subset functions of ConnectionRecordSet.

Browse Source
This commit is contained in:
James Muehlner
2015-10-06 22:47:04 -07:00
parent 3c5f72b288
commit 1b5663f5c0
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/ConnectionRecordSet.java
View File

@@ -80,7 +80,10 @@ public interface ConnectionRecordSet {
/** /**
* Returns the subset of connection records to only those where the * Returns the subset of connection records to only those where the
* connection name, user identifier, or any associated date field contain * connection name, user identifier, or any associated date field contain
* the given value. * the given value. This function may also affect the contents of the
* current ConnectionRecordSet. The contents of the current
* ConnectionRecordSet should NOT be relied upon after this function is
* called.
* *
* @param value * @param value
* The value which all connection records within the resulting subset * The value which all connection records within the resulting subset
@@ -99,7 +102,10 @@ public interface ConnectionRecordSet {
/** /**
* Returns the subset of connection history records containing only the * Returns the subset of connection history records containing only the
* first <code>limit</code> records. If the subset has fewer than * first <code>limit</code> records. If the subset has fewer than
* <code>limit</code> records, then this function has no effect. * <code>limit</code> records, then this function has no effect. This
* function may also affect the contents of the current
* ConnectionRecordSet. The contents of the current ConnectionRecordSet
* should NOT be relied upon after this function is called.
* *
* @param limit * @param limit
* The maximum number of records that the new subset should contain. * The maximum number of records that the new subset should contain.
@@ -117,7 +123,9 @@ public interface ConnectionRecordSet {
* Returns a ConnectionRecordSet containing identically the records within * Returns a ConnectionRecordSet containing identically the records within
* this set, sorted according to the specified criteria. The sort operation * this set, sorted according to the specified criteria. The sort operation
* performed is guaranteed to be stable with respect to any past call to * performed is guaranteed to be stable with respect to any past call to
* sort(). * sort(). This function may also affect the contents of the current
* ConnectionRecordSet. The contents of the current ConnectionRecordSet
* should NOT be relied upon after this function is called.
* *
* @param property * @param property
* The property by which the connection records within the resulting * The property by which the connection records within the resulting