NonsenseShipOrPub

java.lang.Object
- net.zer0bandwidth.android.lib.nonsense.NonsenseShipOrPub

All Implemented Interfaces:

NonsenseGenerator
```
public class NonsenseShipOrPub
extends java.lang.Object
implements NonsenseGenerator
```
Builds a random name of a ship… or a pub… or something.
Both ships and pubs seem to have names that follow the general pattern of "The <adjective> <noun>", like "The Salty Dog" or "The Mourning Glory" or "The Rapacious Tardigrade". OK, maybe not the last one. Anyway, since NonsenseBuilder worked out so well, and this is actually a simpler algorithm, it seemed only right to go ahead with this now.

As with NonsenseBuilder, this class makes use of two of the array resources that are included with the library:
- R.array#asNonsenseAdjectives
- R.array#asNonsenseNouns
Applications using this class may choose to have overrides for either or both of these string resources, in order to customize the text that might be rendered in the randomized names.
Since:

zer0bandwidth-net/android 0.1.5 (#11)

Nested Class Summary
- Nested classes/interfaces inherited from interface net.zer0bandwidth.android.lib.nonsense.NonsenseGenerator
  NonsenseGenerator.Utils

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`DEFAULT_ARTICLE_CHANCE` By default, this class will always begin the name with a "The".
`protected java.lang.String[]`	`m_asAdjectives` A list of adjectives.
`protected java.lang.String[]`	`m_asNouns` A list of nouns.
`protected android.content.Context`	`m_ctx` A context in which the string resources are available.
`protected int`	`m_nArticleChance` The percent chance that the builder will begin the random name with "The".
`protected static java.util.Random`	`RANDOM` The internal RNG of the builder, used to select each token in the name.

Constructor Summary

Constructors
Constructor and Description

NonsenseShipOrPub(android.content.Context ctx)
A constructor which sets the resource context.

Constructors
Constructor and Description
`NonsenseShipOrPub(android.content.Context ctx)` A constructor which sets the resource context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`getArticle()` Might start us off with ah "The".
`java.lang.String`	`getString()` Generates the name.
`protected java.lang.String`	`getStrippedNoun()` Ensures that we strip any article that was already included with the noun resource.
`NonsenseShipOrPub`	`setAdjectives(java.util.Collection<java.lang.String> asAdjectives)` Defines the set of adjectives that should be considered when generating the name.
`NonsenseShipOrPub`	`setAdjectives(int resAdjectives)` Defines the set of adjectives that should be considered when generating the name.
`NonsenseShipOrPub`	`setArticleChance(int nChance)` Sets the chance that the builder will begin the name with "The".
`NonsenseShipOrPub`	`setContext(android.content.Context ctx)` Sets the resource context.
`NonsenseShipOrPub`	`setNouns(java.util.Collection<java.lang.String> asNouns)` Defines the set of nouns that should be considered when generating the name.
`NonsenseShipOrPub`	`setNouns(int resNouns)` Defines the set of nouns that should be considered when generating the name.

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

- Field Detail
  - RANDOM
```
protected static final java.util.Random RANDOM
```
    The internal RNG of the builder, used to select each token in the name.
  - DEFAULT_ARTICLE_CHANCE
```
protected static final int DEFAULT_ARTICLE_CHANCE
```
    By default, this class will always begin the name with a "The". Use the setArticleChance(int) method to alter the instance's chance at runtime.
    
    See Also:
    
    m_nArticleChance, Constant Field Values
  - m_ctx
```
protected android.content.Context m_ctx
```
    A context in which the string resources are available.
  - m_nArticleChance
```
protected int m_nArticleChance
```
    The percent chance that the builder will begin the random name with "The". By default, this chance is 100%; consumers may change this by calling setArticleChance(int).
    
    See Also:
    
    DEFAULT_ARTICLE_CHANCE
  - m_asAdjectives
```
protected java.lang.String[] m_asAdjectives
```
    A list of adjectives. This may be overridden with setAdjectives(int).
  - m_asNouns
```
protected java.lang.String[] m_asNouns
```
    A list of nouns. This may be overridden with setNouns(int).
- Constructor Detail
  - NonsenseShipOrPub
```
public NonsenseShipOrPub(android.content.Context ctx)
```
    A constructor which sets the resource context.
    
    Parameters:
    
    ctx - a context in which string resources are available
- Method Detail
  - setContext
```
public NonsenseShipOrPub setContext(android.content.Context ctx)
```
    Sets the resource context.
    
    Specified by:
    
    setContext in interface NonsenseGenerator
    
    Parameters:
    
    ctx - the context in which string resources are available
    
    Returns:
    
    (fluid)
  - setArticleChance
```
public NonsenseShipOrPub setArticleChance(int nChance)
```
    Sets the chance that the builder will begin the name with "The". By default, this chance is 100%. If the parameter given is less than 0 or greater than 100, then the new value will be silently ignored.
    
    Parameters:
    
    nChance - an integer between 0 and 100 (inclusive)
    
    Returns:
    
    (fluid)
  - setAdjectives
```
public NonsenseShipOrPub setAdjectives(int resAdjectives)
```
    Defines the set of adjectives that should be considered when generating the name.
    
    Parameters:
    
    resAdjectives - the resource ID of an array of adjectives
    
    Returns:
    
    (fluid)
  - setAdjectives
```
public NonsenseShipOrPub setAdjectives(java.util.Collection<java.lang.String> asAdjectives)
```
    Defines the set of adjectives that should be considered when generating the name.
    
    Parameters:
    
    asAdjectives - a collection of adjective strings
    
    Returns:
    
    (fluid)
  - setNouns
```
public NonsenseShipOrPub setNouns(int resNouns)
```
    Defines the set of nouns that should be considered when generating the name.
    
    Parameters:
    
    resNouns - the resource ID of an array of nouns
    
    Returns:
    
    (fluid)
  - setNouns
```
public NonsenseShipOrPub setNouns(java.util.Collection<java.lang.String> asNouns)
```
    Defines the set of nouns that should be considered when generating the name.
    
    Parameters:
    
    asNouns - a collection of noun strings
    
    Returns:
    
    (fluid)
  - getString
```
public java.lang.String getString()
```
    Generates the name.
    
    Specified by:
    
    getString in interface NonsenseGenerator
    
    Returns:
    
    the name of a ship, or a pub, or whatever
  - getArticle
```
protected java.lang.String getArticle()
```
    Might start us off with ah "The". Or it might not.
    
    Returns:
    
    "The " or an empty string
  - getStrippedNoun
```
protected java.lang.String getStrippedNoun()
```
    Ensures that we strip any article that was already included with the noun resource.
    
    Returns:
    
    the naked noun

Class NonsenseShipOrPub

Nested Class Summary

Nested classes/interfaces inherited from interface net.zer0bandwidth.android.lib.nonsense.NonsenseGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RANDOM

DEFAULT_ARTICLE_CHANCE

m_ctx

m_nArticleChance

m_asAdjectives

m_asNouns

Constructor Detail

NonsenseShipOrPub

Method Detail

setContext

setArticleChance

setAdjectives

setAdjectives

setNouns

setNouns

getString

getArticle

getStrippedNoun