info.idevelopment.utils
Class InfoString

java.lang.Object
  |
  +--info.idevelopment.utils.InfoString

public class InfoString

extends java.lang.Object

Primarily used to return the length or substring of a given String object. This class also implements many of the conventions used in the "Java Coding and Documenting Conventions" guide within the DBA Documentation Library.

For more information on the different features of Javadoc, visit Javadoc Tool Home Page

Since:

SDK1.4

Version:

1.0, 07-SEP-2002

Author:

Jeffrey Hunter

, jhunter@iDevelopment.info , www.iDevelopment.info

Constructor Summary

InfoString(java.lang.String s)
Sole constructor.

Method Summary

int	getLength() Gets the current length of the object string.
java.lang.String	getOriginalString() Gets the original String used when object was created.
java.lang.String	getSubstring(int offset) Used to return a portion of the stored string object starting at the offset and continue to the end.
java.lang.String	getSubstring(int offset, int length) Used to return a portion of the stored string object using an offset and particular length.

Methods inherited from class java.lang.Object

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

Constructor Detail

InfoString

public InfoString(java.lang.String s)

Sole constructor. Accepts and stores a String for use by this class.

Parameters:

s - The String to be stored and worked on by this class.

Method Detail

getOriginalString

public java.lang.String getOriginalString()

Gets the original String used when object was created.

Returns:

Original String passed in when object was created.

getLength

public int getLength()

Gets the current length of the object string.

Returns:

The current length of the object string.

getSubstring

public java.lang.String getSubstring(int offset,
                                     int length)

Used to return a portion of the stored string object using an offset and particular length. Length should be greater than the offset value.

Parameters:

offset - Position in the original stored string to start from.

length - Length of the original stored string object to return.

Returns:

Portion of the string using offset and length.

getSubstring

public java.lang.String getSubstring(int offset)

Used to return a portion of the stored string object starting at the offset and continue to the end. The end of the string will be determined by the length of the string.

Parameters:

offset - Position in the original stored string to start from.

Returns:

Portion of the string starting at the offset.