Messaging.NounTrait (squidlib-util 3.0.6 API)

java.lang.Object
- java.lang.Enum<Messaging.NounTrait>
- - squidpony.Messaging.NounTrait

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Messaging.NounTrait>

Enclosing class:

Messaging
```
public static enum Messaging.NounTrait
extends java.lang.Enum<Messaging.NounTrait>
```
Properties of nouns needed to correctly conjugate those nouns and refer to them with pronouns, such as genders. Includes parts of speech, which only are concerned with whether they refer to a singular noun or a plural noun, and genders for when a gendered pronoun is needed. This provides substantial support for uncommon cases regarding gender and pronoun preferences. That said, gender and pronoun preference can be incredibly hard to handle. The simplest cases are for first- and second-person pronouns; here we have "I/me/my/myself" for FIRST_PERSON_SINGULAR, "you/you/your/yourself" for SECOND_PERSON_SINGULAR, "we/us/our/ourselves" for FIRST_PERSON_PLURAL, and "you/you/your/yourselves" for SECOND_PERSON_PLURAL; there are more pronouns this can produce, but they aren't listed here. Third-person pronouns are considerably more challenging because English sporadically considers gender as part of conjugation, but doesn't provide a universally-acceptable set of gendered pronouns.
This at least tries to provide pronoun handling for the common cases, such as "you" not needing a gendered pronoun at all (it uses SECOND_PERSON_SINGULAR), and supports male, female, genderless (using "it" and related forms; preferred especially for things that aren't alive, and in most cases not recommended for people), "unspecified" (using "they" in place of "he" or "she"; preferred in some cases when describing someone with a non-specific gender or an unknown gender) pronouns, and group for when a group of individuals, regardless of gender or genders, is referred to with a single pronoun. As mentioned, this has support for some uncommon situations, like additional gender (as in, a gender that is in addition to male and female but that is not genderless, which has a clear use case when describing non-human species, and a more delicate use for humans who use non-binary gender pronouns; hopefully "xe" will be acceptable), and finally a "special case" pronoun that is unpronounceable and, if given special processing, can be used as a replacement target for customized pronouns. For the additional gender, the non-binary gendered pronouns are modified from the male pronouns by replacing 'h' with 'x' (he becomes xe, his becomes xis). The "special case" pronouns replace the 'h' in the male pronouns with 'qvq', except for in one case. Where, if the female pronoun were used, it would be "hers", but the male pronoun in that case would be "his", changing the male pronoun would lead to a difficult-to-replace case because "his" is also used in the case where the female pronoun is the usefully distinct "her". Here, the "special case" gender diverges from what it usually does, and uses "qvqims" in place of "his" or "hers". The "special case" pronouns should be replaced before being displayed, since they look like gibberish or a glitch and so are probably confusing out of context.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADDITIONAL_GENDER` Third-gender pronoun preference, potentially relevant for cultures with non-binary gender terms.
`FEMALE_GENDER` Female pronoun preference, as in "She is her own boss." name/name_s/i/me/my/mine/myself Name/Name's/she/she/her/hers/herself "^i hurr^$$$" becomes "she hurries".
`FIRST_PERSON_PLURAL` As in, "We are our own bosses." Doesn't reference gender, and applies to groups.
`FIRST_PERSON_SINGULAR` As in, "I am my own boss." Doesn't reference gender.
`GROUP` Any third-person plural, as in "They are their own bosses." Not to be confused with UNSPECIFIED_GENDER, which is for singular beings, but usually uses "they" in the same way (not always).
`MALE_GENDER` Male pronoun preference, as in "He is his own boss." name/name_s/i/me/my/mine/myself Name/Name's/he/he/his/his/himself "^i hurr^$$$" becomes "he hurries".
`NO_GENDER` Inanimate objects or beings without gender, as in "It is its own boss." name/name_s/i/me/my/mine/myself Name/Name's/it/it/its/its/itself "^i hurr^$$$" becomes "it hurries".
`SECOND_PERSON_PLURAL` As in, "You are your own bosses." Doesn't reference gender, and applies to groups.
`SECOND_PERSON_SINGULAR` As in, "You are your own boss." Doesn't reference gender.
`SPECIAL_CASE_GENDER` Unpronounceable words that can be processed specially for more complex cases of pronoun preference.
`UNSPECIFIED_GENDER` "Singular they" pronoun preference or to be used when preference is unknown, as in "They are their own boss." name/name_s/i/me/my/mine/myself Name/Name's/they/them/their/theirs/themself "^i hurr^$$$" becomes "they hurry".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`$$$Text()`
`java.lang.String`	`$$Text()`
`java.lang.String`	`$Text()`
`java.lang.String`	`directText(java.lang.String term)`
`java.lang.String`	`fvesText()`
`java.lang.String`	`iText()`
`java.lang.String`	`meText()`
`java.lang.String`	`mineText()`
`java.lang.String`	`myselfText()`
`java.lang.String`	`myText()`
`java.lang.String`	`name_sText(java.lang.String term)`
`java.lang.String`	`nameText(java.lang.String term)`
`java.lang.String`	`sssText()`
`java.lang.String`	`ssText()`
`java.lang.String`	`sText()`
`java.lang.String`	`usiText()`
`static Messaging.NounTrait`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Messaging.NounTrait[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - FIRST_PERSON_SINGULAR
```
public static final Messaging.NounTrait FIRST_PERSON_SINGULAR
```
    As in, "I am my own boss." Doesn't reference gender.
    name/name_s/i/me/my/mine/myself
    I/my/I/me/my/mine/myself "^i hurr^$$$" becomes "I hurry". Does not pluralize.
  - SECOND_PERSON_SINGULAR
```
public static final Messaging.NounTrait SECOND_PERSON_SINGULAR
```
    As in, "You are your own boss." Doesn't reference gender.
    name/name_s/i/me/my/mine/myself
    you/your/you/you/your/yours/yourself "^i hurr^$$$" becomes "you hurry". Does not pluralize.
  - FIRST_PERSON_PLURAL
```
public static final Messaging.NounTrait FIRST_PERSON_PLURAL
```
    As in, "We are our own bosses." Doesn't reference gender, and applies to groups.
    name/name_s/i/me/my/mine/myself
    we/our/we/us/our/ours/ourselves "^i hurr^$$$" becomes "we hurry". Pluralizes.
  - SECOND_PERSON_PLURAL
```
public static final Messaging.NounTrait SECOND_PERSON_PLURAL
```
    As in, "You are your own bosses." Doesn't reference gender, and applies to groups.
    name/name_s/i/me/my/mine/myself
    you/your/you/you/your/yours/yourselves "^i hurr^$$$" becomes "you hurry". Pluralizes.
  - NO_GENDER
```
public static final Messaging.NounTrait NO_GENDER
```
    Inanimate objects or beings without gender, as in "It is its own boss."
    name/name_s/i/me/my/mine/myself
    Name/Name's/it/it/its/its/itself "^i hurr^$$$" becomes "it hurries". Does not pluralize.
  - MALE_GENDER
```
public static final Messaging.NounTrait MALE_GENDER
```
    Male pronoun preference, as in "He is his own boss."
    name/name_s/i/me/my/mine/myself
    Name/Name's/he/he/his/his/himself "^i hurr^$$$" becomes "he hurries". Does not pluralize.
  - FEMALE_GENDER
```
public static final Messaging.NounTrait FEMALE_GENDER
```
    Female pronoun preference, as in "She is her own boss."
    name/name_s/i/me/my/mine/myself
    Name/Name's/she/she/her/hers/herself "^i hurr^$$$" becomes "she hurries". Does not pluralize.
  - UNSPECIFIED_GENDER
```
public static final Messaging.NounTrait UNSPECIFIED_GENDER
```
    "Singular they" pronoun preference or to be used when preference is unknown, as in "They are their own boss."
    name/name_s/i/me/my/mine/myself
    Name/Name's/they/them/their/theirs/themself "^i hurr^$$$" becomes "they hurry". Does not pluralize.
  - ADDITIONAL_GENDER
```
public static final Messaging.NounTrait ADDITIONAL_GENDER
```
    Third-gender pronoun preference, potentially relevant for cultures with non-binary gender terms. As in, "Xe is xis own boss."
    name/name_s/i/me/my/mine/myself
    Name/Name's/xe/xim/xis/xis/ximself "^i hurr^$$$" becomes "xe hurries". Does not pluralize.
  - SPECIAL_CASE_GENDER
```
public static final Messaging.NounTrait SPECIAL_CASE_GENDER
```
    Unpronounceable words that can be processed specially for more complex cases of pronoun preference. As in, "Qvqe is qvqis own boss."
    name/name_s/i/me/my/mine/myself
    Name/Name's/qvqe/qvqim/qvqis/qvqims/qvqimself "^i hurr^$$$" becomes "qvqe hurries". Does not pluralize.
  - GROUP
```
public static final Messaging.NounTrait GROUP
```
    Any third-person plural, as in "They are their own bosses." Not to be confused with UNSPECIFIED_GENDER, which is for singular beings, but usually uses "they" in the same way (not always).
    name/name_s/i/me/my/mine/myself
    Name/Name's/they/them/their/theirs/themselves "^i hurr^$$$" becomes "they hurry". Pluralizes.
- Method Detail
  - values
```
public static Messaging.NounTrait[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Messaging.NounTrait c : Messaging.NounTrait.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Messaging.NounTrait valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - nameText
```
public java.lang.String nameText(java.lang.String term)
```
  - name_sText
```
public java.lang.String name_sText(java.lang.String term)
```
  - iText
```
public java.lang.String iText()
```
  - meText
```
public java.lang.String meText()
```
  - myText
```
public java.lang.String myText()
```
  - mineText
```
public java.lang.String mineText()
```
  - myselfText
```
public java.lang.String myselfText()
```
  - sText
```
public java.lang.String sText()
```
  - ssText
```
public java.lang.String ssText()
```
  - sssText
```
public java.lang.String sssText()
```
  - usiText
```
public java.lang.String usiText()
```
  - fvesText
```
public java.lang.String fvesText()
```
  - $Text
```
public java.lang.String $Text()
```
  - $$Text
```
public java.lang.String $$Text()
```
  - $$$Text
```
public java.lang.String $$$Text()
```
  - directText
```
public java.lang.String directText(java.lang.String term)
```

Enum Messaging.NounTrait

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FIRST_PERSON_SINGULAR

SECOND_PERSON_SINGULAR

FIRST_PERSON_PLURAL

SECOND_PERSON_PLURAL

NO_GENDER

MALE_GENDER

FEMALE_GENDER

UNSPECIFIED_GENDER

ADDITIONAL_GENDER

SPECIAL_CASE_GENDER

GROUP

Method Detail

values

valueOf

nameText

name_sText

iText

meText

myText

mineText

myselfText

sText

ssText

sssText

usiText

fvesText

$Text

$$Text

$$$Text

directText