simplenlg.features

Enum Person

java.lang.Object

java.lang.Enum<Person>

simplenlg.features.Person

All Implemented Interfaces:

Serializable, Comparable<Person>

public enum Person
extends Enum<Person>

This is an enumeration used to represent the point of view of the narrative. It covers first person, second person and third person. The person is recorded in the Feature.PERSON feature and applies to clauses, coordinated phrases, noun phrases and verb phrases.

Version:

4.0

Author:

A. Gatt, D. Westwater, University of Aberdeen.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST The enumeration to show that the narration is written in the first person.
SECOND The enumeration to show that the narration is written in the second person.
THIRD The enumeration to show that the narration is written in the third person.

Method Summary

Modifier and Type	Method and Description
static Person	valueOf(String name) Returns the enum constant of this type with the specified name.
static Person[]	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

public static final Person FIRST

The enumeration to show that the narration is written in the first person. First person narrative uses the personal pronouns of I and we.

SECOND

public static final Person SECOND

The enumeration to show that the narration is written in the second person. Second person narrative uses the personal pronoun of you.

THIRD

public static final Person THIRD

The enumeration to show that the narration is written in the third person. Third person narrative uses the personal pronouns of he, her and they.

Method Detail

values

public static Person[] 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 (Person c : Person.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Person valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null