NonsenseBuilder

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

All Implemented Interfaces:

NonsenseGenerator
```
public class NonsenseBuilder
extends java.lang.Object
implements NonsenseGenerator
```
The canonical implementation of NonsenseGenerator.
The builder will assemble a sentence of the following form: adjective subject adverb verb adjective object phrase. The terms listed in bold (subject, verb, object) will always be rendered, while the terms in italics (adjectives, adverbs, additional phrases) will be added randomly based on the builder's configuration, which can be tuned by creating a custom instance of the NonsenseBuilder.Configuration inner class.

The class uses the following string resources to get its random words:
- R.array#asNonsenseNouns
- R.array#asNonsenseVerbs
- R.array#asNonsenseAdjectives
- R.array#asNonsenseAdverbs
- R.array#asNonsensePhrases
Applications using this class may choose to have overrides for any or all of these string resources, in order to customize the text that might be rendered in the randomized sentences.
Since:

zer0bandwidth-net/android 0.0.1 (#7)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NonsenseBuilder.Configuration` This class controls aspects of a `NonsenseBuilder` related to the probability of certain random features.

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 NonsenseBuilder.Configuration`	`CANONICAL_CONFIGURATION` A canonical instance of a `NonsenseBuilder.Configuration`, using the default values defined in that inner class.
`protected NonsenseBuilder.Configuration`	`m_cfg` The configuration settings that will control the random elements of the builder.
`protected android.content.Context`	`m_ctx` A context in which string resources are available.
`protected java.lang.String`	`m_sObject` (noun) The object of the sentence.
`protected java.lang.String`	`m_sObjectAdjective` (adjective) A modifier of the object of the sentence.
`protected java.lang.String`	`m_sObjectModifier` (prepositional phrase) A phrase further modifying the object of the sentence.
`protected java.lang.String`	`m_sSubject` (noun) The subject of the sentence.
`protected java.lang.String`	`m_sSubjectAdjective` (adjective) A modifier of the subject.
`protected java.lang.String`	`m_sVerb` (verb) The action verb in the sentence.
`protected java.lang.String`	`m_sVerbAdverb` (adverb) A modifier of the sentence's verb.
`protected static java.util.Random`	`RANDOM` The internal RNG of the builder, used to determine the value selected for each item in the sentence, and the presence of certain optional items.

Constructor Summary

Constructors
Constructor and Description
`NonsenseBuilder(android.content.Context ctx)` A constructor which sets the resource context.
`NonsenseBuilder(android.content.Context ctx, NonsenseBuilder.Configuration cfg)` A constructor which sets both the resource context and a custom configuration to control the random aspects of the builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected NonsenseBuilder`	`appendObject(java.lang.StringBuilder sb)` Appends the object and its adjective and modifier phrase (if any) to the buffer in which the sentence is being constructed.
`protected NonsenseBuilder`	`appendSubject(java.lang.StringBuilder sb)` Appends the subject and its adjective (if any) to the buffer in which the sentence is being constructed.
`protected NonsenseBuilder`	`appendVerb(java.lang.StringBuilder sb)` Appends the verb and its adverb (if any) to the buffer in which the sentence is being constructed.
`java.lang.String`	`getRandomNonsense(int resStrings, int nChance)` Randomly selects a string resource from the selected string array.
`java.lang.String`	`getString()` Generates the nonsense string.
`NonsenseBuilder`	`setAdverb(java.lang.String sAdverb)` Locks a value for the adverb modifying the verb of the sentence.
`NonsenseBuilder`	`setConfiguration(NonsenseBuilder.Configuration cfg)` Sets the configuration parameters of the builder.
`NonsenseBuilder`	`setContext(android.content.Context ctx)` Sets the context in which string resources can be fetched.
`NonsenseBuilder`	`setObject(java.lang.String sObject)` Locks a value for the object of the sentence.
`NonsenseBuilder`	`setObjectAdjective(java.lang.String sAdj)` Locks a value for the adjective modifying the object of the sentence.
`NonsenseBuilder`	`setObjectModifier(java.lang.String sPhrase)` Locks a value for additional text (expected to be a prepositional phrase) modifying the object of the sentence.
`NonsenseBuilder`	`setSubject(java.lang.String sSubject)` Locks a value for the subject of the sentence.
`NonsenseBuilder`	`setSubjectAdjective(java.lang.String sAdj)` Locks a value for the adjective modifying the subject of the sentence.
`NonsenseBuilder`	`setVerb(java.lang.String sVerb)` Locks a value for the verb of the sentence.

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

- Field Detail
  - CANONICAL_CONFIGURATION
```
protected static final NonsenseBuilder.Configuration CANONICAL_CONFIGURATION
```
    A canonical instance of a NonsenseBuilder.Configuration, using the default values defined in that inner class.
  - RANDOM
```
protected static final java.util.Random RANDOM
```
    The internal RNG of the builder, used to determine the value selected for each item in the sentence, and the presence of certain optional items.
  - m_ctx
```
protected android.content.Context m_ctx
```
    A context in which string resources are available.
  - m_cfg
```
protected NonsenseBuilder.Configuration m_cfg
```
    The configuration settings that will control the random elements of the builder. This defaults to the CANONICAL_CONFIGURATION.
  - m_sSubject
```
protected java.lang.String m_sSubject
```
    (noun) The subject of the sentence. This is always set by the builder.
  - m_sSubjectAdjective
```
protected java.lang.String m_sSubjectAdjective
```
    (adjective) A modifier of the subject. This is randomly set by the builder.
  - m_sVerb
```
protected java.lang.String m_sVerb
```
    (verb) The action verb in the sentence. This is always set by the builder.
  - m_sVerbAdverb
```
protected java.lang.String m_sVerbAdverb
```
    (adverb) A modifier of the sentence's verb. This is randomly set by the builder.
  - m_sObject
```
protected java.lang.String m_sObject
```
    (noun) The object of the sentence. This is always set by the builder.
  - m_sObjectAdjective
```
protected java.lang.String m_sObjectAdjective
```
    (adjective) A modifier of the object of the sentence. This is randomly set by the builder.
  - m_sObjectModifier
```
protected java.lang.String m_sObjectModifier
```
    (prepositional phrase) A phrase further modifying the object of the sentence. This is randomly set by the builder.
- Constructor Detail
  - NonsenseBuilder
```
public NonsenseBuilder(android.content.Context ctx)
```
    A constructor which sets the resource context.
    
    Parameters:
    
    ctx - a context in which string resources are available
  - NonsenseBuilder
```
public NonsenseBuilder(android.content.Context ctx,
                       NonsenseBuilder.Configuration cfg)
```
    A constructor which sets both the resource context and a custom configuration to control the random aspects of the builder.
    
    Parameters:
    
    ctx - a context in which string resources are available
    
    cfg - the configuration parameters of the builder
- Method Detail
  - setConfiguration
```
public NonsenseBuilder setConfiguration(NonsenseBuilder.Configuration cfg)
```
    Sets the configuration parameters of the builder.
    
    Parameters:
    
    cfg - specifies the randomization parameters for the builder
    
    Returns:
    
    (fluid)
  - setContext
```
public NonsenseBuilder setContext(android.content.Context ctx)
```
    Description copied from interface: NonsenseGenerator
    
    Sets the context in which string resources can be fetched. If this context has not yet been set, then the class will not be able to fetch string resources to assemble the nonsense string. Implementations of this interface should also provide a constructor which sets this context upfront.
    
    Specified by:
    
    setContext in interface NonsenseGenerator
    
    Parameters:
    
    ctx - the context in which string resources are available
    
    Returns:
    
    (fluid)
  - setSubject
```
public NonsenseBuilder setSubject(java.lang.String sSubject)
```
    Locks a value for the subject of the sentence. If null is specified, then the builder's subject will be "cleared", meaning that it will be chosen at random.
    
    Parameters:
    
    sSubject - a specific subject for the sentence, or null to ensure that the subject is randomized
    
    Returns:
    
    (fluid)
  - setSubjectAdjective
```
public NonsenseBuilder setSubjectAdjective(java.lang.String sAdj)
```
    Locks a value for the adjective modifying the subject of the sentence. If null is specified, then the builder might or might not add a random adjective, as specified by NonsenseBuilder.Configuration.m_nSubjectAdjectiveChance.
    
    Parameters:
    
    sAdj - a specific adjective to modify the subject of the sentence, or null to randomize the presence and value of the adjective
    
    Returns:
    
    (fluid)
  - setVerb
```
public NonsenseBuilder setVerb(java.lang.String sVerb)
```
    Locks a value for the verb of the sentence. If null is specified, then the builder's verb will be "cleared", meaning that it will be chosen at random.
    
    Parameters:
    
    sVerb - a specific verb for the sentence, or null to ensure that the verb is randomized
    
    Returns:
    
    (fluid)
  - setAdverb
```
public NonsenseBuilder setAdverb(java.lang.String sAdverb)
```
    Locks a value for the adverb modifying the verb of the sentence. If null is specified, then the builder might or might not add a random adverb, as specified by NonsenseBuilder.Configuration.m_nAdverbChance.
    
    Parameters:
    
    sAdverb - a specific adverb to modify the verb of the sentence, or null to randomize the presence and value of the adverb
    
    Returns:
    
    (fluid)
  - setObject
```
public NonsenseBuilder setObject(java.lang.String sObject)
```
    Locks a value for the object of the sentence. If null is specified, then the builder's object will be "cleared", meaning that it will be chosen at random.
    
    Parameters:
    
    sObject - a specific object for the sentence, or null to ensure that the object is randomized
    
    Returns:
    
    (fluid)
  - setObjectAdjective
```
public NonsenseBuilder setObjectAdjective(java.lang.String sAdj)
```
    Locks a value for the adjective modifying the object of the sentence. If null is specified, then the builder might or might not add a random adjective, as specified by NonsenseBuilder.Configuration.m_nObjectAdjectiveChance.
    
    Parameters:
    
    sAdj - a specific adjective to modify the object of the sentence, or null to randomize the presence and value of the adjective
    
    Returns:
    
    (fluid)
  - setObjectModifier
```
public NonsenseBuilder setObjectModifier(java.lang.String sPhrase)
```
    Locks a value for additional text (expected to be a prepositional phrase) modifying the object of the sentence. If null is specified, then the builder might or might not add a random phrase, as specified by NonsenseBuilder.Configuration.m_nObjectPhraseChance.
    
    Parameters:
    
    sPhrase - specific text to modify the object of the sentence, or null to randomize the presence and value of such text
    
    Returns:
    
    (fluid)
  - getString
```
public java.lang.String getString()
```
    Description copied from interface: NonsenseGenerator
    
    Generates the nonsense string. The algorithm for creating the string is implementation-dependent.
    
    Specified by:
    
    getString in interface NonsenseGenerator
    
    Returns:
    
    a fully-formed sentence from randomly-selected words
  - appendSubject
```
protected NonsenseBuilder appendSubject(java.lang.StringBuilder sb)
```
    Appends the subject and its adjective (if any) to the buffer in which the sentence is being constructed.
    
    Parameters:
    
    sb - the buffer in which the sentence is being constructed
    
    Returns:
    
    (fluid)
  - appendVerb
```
protected NonsenseBuilder appendVerb(java.lang.StringBuilder sb)
```
    Appends the verb and its adverb (if any) to the buffer in which the sentence is being constructed.
    
    Parameters:
    
    sb - the buffer in which the sentence is being constructed
    
    Returns:
    
    (fluid)
  - appendObject
```
protected NonsenseBuilder appendObject(java.lang.StringBuilder sb)
```
    Appends the object and its adjective and modifier phrase (if any) to the buffer in which the sentence is being constructed.
    
    Parameters:
    
    sb - the buffer in which the sentence is being constructed
    
    Returns:
    
    (fluid)
  - getRandomNonsense
```
public java.lang.String getRandomNonsense(int resStrings,
                                          int nChance)
```
    Randomly selects a string resource from the selected string array.
    
    Parameters:
    
    resStrings - the resource ID of a string array
    
    nChance - chance that we should return anything at all, expressed as a percentage (expected range [0,100])
    
    Returns:
    
    a random string from that array of strings

Class NonsenseBuilder

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

CANONICAL_CONFIGURATION

RANDOM

m_ctx

m_cfg

m_sSubject

m_sSubjectAdjective

m_sVerb

m_sVerbAdverb

m_sObject

m_sObjectAdjective

m_sObjectModifier

Constructor Detail

NonsenseBuilder

NonsenseBuilder

Method Detail

setConfiguration

setContext

setSubject

setSubjectAdjective

setVerb

setAdverb

setObject

setObjectAdjective

setObjectModifier

getString

appendSubject

appendVerb

appendObject

getRandomNonsense