com.rubecula.util
Class StringPresentation

java.lang.Object
  |
  +--com.rubecula.util.Presentation
        |
        +--com.rubecula.util.StringPresentation

All Implemented Interfaces:

Auditable

public class StringPresentation

extends Presentation

Title:

Description:

Copyright: Copyright (c) 2003

Company: Rubecula Software

Version:

$Revision:$

Author:

Robin Hillyard

Field Summary

Fields inherited from class com.rubecula.util.Presentation

$empty, $Stars

Constructor Summary

StringPresentation(java.lang.String value)

Method Summary

java.lang.String	audit(java.lang.String label) Method to return a detailed string from an object for debugging purposes.
java.lang.String	getIdentifier() Method to get the specific identifier for an object.
Presentable	parse() Convert this Presentation into a Presentable object.
java.lang.String	toString(int width) Render this Presentation as a String within the width specified.

Methods inherited from class com.rubecula.util.Presentation

audit, audit, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringPresentation

public StringPresentation(java.lang.String value)

Method Detail

toString

public java.lang.String toString(int width)
                          throws PresentationException

Description copied from class: Presentation

Render this Presentation as a String within the width specified.

Specified by:

toString in class Presentation

Parameters:

width - the max. number of characters within which to output the presentation.

Returns:

a representation (rendering) of this Presentation.

Throws:

PresentationException - if the presentation cannot be rendered within the given width.

audit

public java.lang.String audit(java.lang.String label)

Description copied from interface: Auditable

Method to return a detailed string from an object for debugging purposes.

Parameters:

label - the label to associate with the data. If label is non-null, a more detailed audit will be returned (this normally occurs only at the top level).

Returns:

the detailed string.

parse

public Presentable parse()
                  throws PresentationException

Description copied from class: Presentation

Convert this Presentation into a Presentable object.

Specified by:

parse in class Presentation

Returns:

an appropriate instance of Presentable.

Throws:

PresentationException - if the presentation cannot be parsed.

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: Auditable

Method to get the specific identifier for an object.

Returns:

the identifier.