Keyword (Java Tool 1.20.2 API)

java.lang.Object
- org.osgl.util.Keyword

All Implemented Interfaces:

Comparable<Keyword>
```
public final class Keyword
extends Object
implements Comparable<Keyword>
```
A Keyword can be presented in the different ways: * CamelCaseStyle * underscore_style * CONSTANT_STYLE * dash-style * “readable style” * “Http-Header-Style”

When reading a string into a keyword, the following separator chars will be ignored and used as separator to construct the keyword
- space ' '
- underscore: _
- dash: -
- comma: ,
- dot: .
- colon: :
- semi-colon: ;
- slash: \
- forward slash: /

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Keyword.F

static class Keyword.Style

Nested Classes
Modifier and Type	Class and Description
`static class`	`Keyword.F`
`static class`	`Keyword.Style`

Field Summary

Fields
Modifier and Type	Field and Description
`static Keyword`	`NULL`
`static char`	`SEP_COLON`
`static char`	`SEP_COMMA`
`static char`	`SEP_DASH`
`static char`	`SEP_DOT`
`static char`	`SEP_FORWARD_SLASH`
`static char`	`SEP_SEMI_COLON`
`static char`	`SEP_SLASH`
`static char`	`SEP_SPACE`
`static char`	`SEP_UNDERSCORE`

Constructor Summary

Constructors
Constructor and Description

Keyword(CharSequence chars)

Constructors
Constructor and Description
`Keyword(CharSequence chars)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`acronym()`
`String`	`camelCase()` The `UpperCamelCase` style
`int`	`compareTo(Keyword o)`
`String`	`constantName()`
`boolean`	`contains(Keyword keyword)` Check if specified keyword is sub sequence of this keyword.
`boolean`	`contains(String string)`
`String`	`dashed()` Returns hyphen separated string.
`String`	`dotted()`
`boolean`	`endsWith(Keyword keyword)` Check if specified keyword equals to or is suffix of this keyword.
`boolean`	`endsWith(String string)`
`static boolean`	`eq(CharSequence a, CharSequence b)` Check if two `CharSequence`s are keyword identical.
`static boolean`	`equals(CharSequence a, CharSequence b)` Check if two `CharSequence`s are keyword identical.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`httpHeader()`
`String`	`hyphenated()` Alias of `dashed()`
`String`	`javaVariable()` The `lowerCamelCase` style
`String`	`kebabCase()` Alias of `dashed()`
`String`	`lowerCamelCase()` Alias of `javaVariable()`
`boolean`	`matches(CharSequence charSequence)`
`boolean`	`matches(Keyword keyword)`
`static boolean`	`neq(CharSequence a, CharSequence b)` Check if two `CharSequence`s are not keyword identical.
`static boolean`	`notEquals(CharSequence a, CharSequence b)` Check if two `CharSequence`s are not keyword identical.
`static Keyword`	`of(CharSequence chars)` Create a `Keyword` for the given `chars`
`String`	`pascalCase()` Alias of `camelCase()`.
`String`	`readable()`
`String`	`snakeCase()` Alias of `underscore()`
`String`	`startCase()`
`boolean`	`startsWith(Keyword keyword)` Check if specified keyword equals to or is prefix of this keyword.
`boolean`	`startsWith(String string)`
`List<String>`	`tokens()`
`String`	`toString()` Returns string representation of this keyword using `underscore style`
`String`	`toString(Keyword.Style style)` Return string representation of this keyword using style specified
`String`	`underscore()`
`String`	`upperCamelCase()` Alias of `camelCase()`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NULL
```
public static final Keyword NULL
```
  - SEP_SPACE
```
public static final char SEP_SPACE
```
    See Also:
    
    Constant Field Values
  - SEP_UNDERSCORE
```
public static final char SEP_UNDERSCORE
```
    See Also:
    
    Constant Field Values
  - SEP_DASH
```
public static final char SEP_DASH
```
    See Also:
    
    Constant Field Values
  - SEP_COMMA
```
public static final char SEP_COMMA
```
    See Also:
    
    Constant Field Values
  - SEP_COLON
```
public static final char SEP_COLON
```
    See Also:
    
    Constant Field Values
  - SEP_DOT
```
public static final char SEP_DOT
```
    See Also:
    
    Constant Field Values
  - SEP_SEMI_COLON
```
public static final char SEP_SEMI_COLON
```
    See Also:
    
    Constant Field Values
  - SEP_SLASH
```
public static final char SEP_SLASH
```
    See Also:
    
    Constant Field Values
  - SEP_FORWARD_SLASH
```
public static final char SEP_FORWARD_SLASH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Keyword
```
public Keyword(CharSequence chars)
```
- Method Detail
  - matches
```
public boolean matches(CharSequence charSequence)
```
  - matches
```
public boolean matches(Keyword keyword)
```
  - acronym
```
public String acronym()
```
  - camelCase
```
public String camelCase()
```
    The UpperCamelCase style
  - upperCamelCase
```
public String upperCamelCase()
```
    Alias of camelCase().
  - pascalCase
```
public String pascalCase()
```
    Alias of camelCase().
  - javaVariable
```
public String javaVariable()
```
    The lowerCamelCase style
  - lowerCamelCase
```
public String lowerCamelCase()
```
    Alias of javaVariable()
  - constantName
```
public String constantName()
```
  - underscore
```
public String underscore()
```
  - snakeCase
```
public String snakeCase()
```
    Alias of underscore()
  - dashed
```
public String dashed()
```
    Returns hyphen separated string.
    
    Returns:
    
    hyphen separated string
  - hyphenated
```
public String hyphenated()
```
    Alias of dashed()
  - kebabCase
```
public String kebabCase()
```
    Alias of dashed()
  - dotted
```
public String dotted()
```
  - httpHeader
```
public String httpHeader()
```
  - startCase
```
public String startCase()
```
  - readable
```
public String readable()
```
  - tokens
```
public List<String> tokens()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns string representation of this keyword using underscore style
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the underscore style representation of this keyword
  - toString
```
public String toString(Keyword.Style style)
```
    Return string representation of this keyword using style specified
    
    Parameters:
    
    style - the style used to print this keyword
    
    Returns:
    
    the printed string of this keyword by style specified
  - contains
```
public boolean contains(Keyword keyword)
```
    Check if specified keyword is sub sequence of this keyword.
    
    Parameters:
    
    keyword - the keyword to check
    
    Returns:
    
    true if the keyword specified is sub sequence of this keyword
  - contains
```
public boolean contains(String string)
```
  - startsWith
```
public boolean startsWith(Keyword keyword)
```
    Check if specified keyword equals to or is prefix of this keyword.
    
    Parameters:
    
    keyword - the keyword to check
    
    Returns:
    
    true if this keyword starts with the specified keyword
  - startsWith
```
public boolean startsWith(String string)
```
  - endsWith
```
public boolean endsWith(Keyword keyword)
```
    Check if specified keyword equals to or is suffix of this keyword.
    
    Parameters:
    
    keyword - the keyword to check
    
    Returns:
    
    true if this keyword ends with the specified keyword
  - endsWith
```
public boolean endsWith(String string)
```
  - compareTo
```
public int compareTo(Keyword o)
```
    Specified by:
    
    compareTo in interface Comparable<Keyword>
  - of
```
public static Keyword of(CharSequence chars)
```
    Create a Keyword for the given chars
    
    Parameters:
    
    chars - A CharSequence
    
    Returns:
    
    a Keyword of the chars
  - eq
```
public static boolean eq(CharSequence a,
                         CharSequence b)
```
    Check if two CharSequences are keyword identical.
    
    This method is an alias of equals(CharSequence, CharSequence).
    
    Parameters:
    
    a - the first char sequence
    
    b - the second char sequence
    
    Returns:
    
    true if a and b are keyword identical
  - neq
```
public static boolean neq(CharSequence a,
                          CharSequence b)
```
    Check if two CharSequences are not keyword identical.
    
    Parameters:
    
    a - the first char sequence
    
    b - the second char sequence
    
    Returns:
    
    true if a and b are not keyword identical
  - equals
```
public static boolean equals(CharSequence a,
                             CharSequence b)
```
    Check if two CharSequences are keyword identical.
    
    This method is an alias of notEquals(CharSequence, CharSequence).
    
    Parameters:
    
    a - the first char sequence
    
    b - the second char sequence
    
    Returns:
    
    true if a and b are keyword identical
  - notEquals
```
public static boolean notEquals(CharSequence a,
                                CharSequence b)
```
    Check if two CharSequences are not keyword identical.
    
    Parameters:
    
    a - the first char sequence
    
    b - the second char sequence
    
    Returns:
    
    true if a and b are not keyword identical

Class Keyword

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL

SEP_SPACE

SEP_UNDERSCORE

SEP_DASH

SEP_COMMA

SEP_COLON

SEP_DOT

SEP_SEMI_COLON

SEP_SLASH

SEP_FORWARD_SLASH

Constructor Detail

Keyword

Method Detail

matches

matches

acronym

camelCase

upperCamelCase

pascalCase

javaVariable

lowerCamelCase

constantName

underscore

snakeCase

dashed

hyphenated

kebabCase

dotted

httpHeader

startCase

readable

tokens

hashCode

equals

toString

toString

contains

contains

startsWith

startsWith

endsWith

endsWith

compareTo

of

eq

neq

equals

notEquals