BaseStringContainer (Open Patrician 1.1.0-SNAPSHOT API)

java.lang.Object
- ch.sahits.game.openpatrician.utilities.model.BaseStringContainer

All Implemented Interfaces:

ITextComponent

Direct Known Subclasses:

CenteredLine, Heading, Paragraph
```
class BaseStringContainer
extends java.lang.Object
implements ITextComponent
```
Base class containing a String.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Jul 10, 2013

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  private java.lang.String contents
- Constructor Summary
  
  Constructors
  Constructor Description
  
  BaseStringContainer(java.lang.String contents)
  Initialize the container with a String.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  (package private) java.lang.String getContents()
  Retrieve the contents.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - contents
```
private final java.lang.String contents
```
- Constructor Detail
  - BaseStringContainer
```
public BaseStringContainer(java.lang.String contents)
```
    Initialize the container with a String.
    
    Parameters:
    
    contents - initial content.
- Method Detail
  - getContents
```
java.lang.String getContents()
```
    Retrieve the contents. As the name of the contents is specific to the implementing class they will have to implement a method with a meaningful name to access the contents underneath.
    
    Returns:
    
    the contents of the container.