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

GUACAMOLE-579: Fix up documentation issues.

Browse Source
This commit is contained in:
Virtually Nick
2019-06-22 19:27:33 -04:00
parent a6601a2bfd
commit a2b3e235e0
2 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
guacamole-ext/src/main/java/org/apache/guacamole/token/TokenName.java
View File

@@ -25,7 +25,7 @@ import java.util.regex.Pattern;
/** /**
* Utility class for generating parameter token names. * Utility class for generating parameter token names.
*/ */
public abstract class TokenName { public class TokenName {
/** /**
* Pattern which matches logical groupings of words within a * Pattern which matches logical groupings of words within a
@@ -57,16 +57,16 @@ public abstract class TokenName {
/** /**
* This utility class should not be instantiated. * This utility class should not be instantiated.
*/ */
protected TokenName() {} private TokenName() {}
/** /**
* Generates the name of the parameter token that should be populated with * Generates the name of the parameter token that should be populated with
* the given string. The provided string will be automatically transformed * the given string. The provided string will be automatically transformed
* from "CamelCase", "headlessCamelCase", "lowercase_with_underscores", * from "CamelCase", "headlessCamelCase", "lowercase_with_underscores",
* and "mixes_ofBoth_Styles" to consistent "UPPERCASE_WITH_UNDERSCORES". * and "mixes_ofBoth_Styles" to consistent "UPPERCASE_WITH_UNDERSCORES".
* Each returned attribute will be prefixed with the string value provided * Each returned token name will be prefixed with the string value provided
* in the prefix. The value provided in prefix will be prepended to the * in the prefix. The value provided in prefix will be prepended to the
* attribute name, but will itself not be transformed. * string, but will itself not be transformed.
* *
* @param name * @param name
* The string to be used to generate the token name. * The string to be used to generate the token name.
@@ -102,9 +102,11 @@ public abstract class TokenName {
} }
/** /**
* Generate the name of a parameter from the given string, and with a blank * Generate the name of a parameter token from the given string, with no
* prefix such that the token name will simply be the transformed version * added prefix, such that the token name will simply be the transformed
* of the string. * version of the string. See
* {@link #canonicalize(java.lang.String, java.lang.String)}
*
* *
* @param name * @param name
* The string to use to generate the token name. * The string to use to generate the token name.

5
guacamole-ext/src/test/java/org/apache/guacamole/token/TokenNameTest.java
View File

@@ -23,14 +23,13 @@ import static org.junit.Assert.assertEquals;
import org.junit.Test; import org.junit.Test;
/** /**
* Test which verifies automatic generation of LDAP-specific connection * Test which verifies automatic generation of connection parameter token names.
* parameter token names.
*/ */
public class TokenNameTest { public class TokenNameTest {
/** /**
* Verifies that TokenName.canonicalize() generates token names as * Verifies that TokenName.canonicalize() generates token names as
* specified, regardless of the naming convention of the attribute. * specified, regardless of the format of the provided string.
*/ */
@Test @Test
public void testCanonicalize() { public void testCanonicalize() {