Preposition

java.lang.Object
- englishlanguage.Preposition

All Implemented Interfaces:

Word<java.lang.String>
```
public class Preposition
extends java.lang.Object
implements Word<java.lang.String>
```
The main feature of this class is to store internally (as a String) an english preposition. The idea of this class is to provide a short and easy way to classify a word in respect to english language. This could be used with the Markov Chains to create clearer random sentences and provide a good way to classify words.

Since:

1.0 SNAPSHOT

Author:

Arthur Brenno

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static @NotNull Preposition`	`createOrRandom(java.lang.String preposition)`	Factory.
`static @NotNull Preposition`	`createPreposition(java.lang.String preposition)`	Factory.
`static @NotNull Preposition`	`createRandom()`	Factory.
`java.lang.String`	`getContent()`	Getter.

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

- Method Detail
  - createRandom
```
@Contract(" -> new")
@NotNull
public static @NotNull Preposition createRandom()
```
    Factory. Creates a random Preposition object.
    
    Returns:
    
    A Preposition object. This object contains a random preposition as "preposition" instance variable.
  - createPreposition
```
@Contract("_ -> new")
@NotNull
public static @NotNull Preposition createPreposition(java.lang.String preposition)
```
    Factory. Creates a Preposition.
    
    Parameters:
    
    preposition - to be verified.
    
    Returns:
    
    A Preposition object. This object will contain a preposition if the preposition provided is really a preposition.
    
    Throws:
    
    java.lang.RuntimeException - if the preposition is not a preposition.
  - createOrRandom
```
@Contract("_ -> new")
@NotNull
public static @NotNull Preposition createOrRandom(java.lang.String preposition)
```
    Factory. Creates a preposition by the input or a random preposition.
    
    Parameters:
    
    preposition - to be verified.
    
    Returns:
    
    Preposition instance.
  - getContent
```
public java.lang.String getContent()
```
    Getter. Returns the preposition.
    
    Specified by:
    
    getContent in interface Word<java.lang.String>
    
    Returns:
    
    preposition.