org.povclipse2.utils

Class StringUtils

java.lang.Object

org.povclipse2.utils.StringUtils

public class StringUtils
extends java.lang.Object

Util class for String functions.

Author:

Wolfgang Möstl

See Also:

gitweb

Field Summary

Fields

Modifier and Type	Field and Description
static char	STRING_ESCAPE_CHARACTER The escape character for String used by the Povray SDL: '\'.

Constructor Summary

Constructors

Constructor and Description
StringUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	bildPath(java.lang.String path1, java.lang.String path2) Builds a new path from the two given parts.
static java.lang.String	changeExtension(java.lang.String name, java.lang.String extension) Exchanges the extension of the given (file) name.
static boolean	containsOnlySpaces(java.lang.String str)
static int	countChar(char[] array, char c)
java.lang.String	ensureMaxLength(java.lang.String str, int maxLen) Ensures that the given String is never longer than the given maxLen.
static java.lang.String	ensureMaxLineLength(java.lang.String text, int maxLineLen) Inserts newlines if a line would be longer than lineLen characters.
static java.lang.String	ensureOnlyWhiteSpaces(java.lang.String str)
static java.lang.String	extractDeclarationName(java.lang.String str)
static java.lang.String	extractDeclarationRValue(java.lang.String str)
static java.lang.String	extractExpression(java.lang.String str) Given '#ifdef (TARGET)' return 'TARGET' FIXME: Broken for case: #ifdef /*(*/ (foo)
static java.lang.String	extractMacroName(java.lang.String str)
static java.lang.String	extractParam(java.lang.String str) Extract a string up to the next comma.
static java.lang.String	extractQuotedString(java.lang.String str, boolean includeQuotes) Extracts everything between the first two ocurrences of a doublequote.
static java.lang.String	extractTo(java.lang.String str, char marker) Extract a string up to this character.
static java.lang.String	extractUSNumber(java.lang.String str, int occurence) Extracts the n-th occurence of a US-styled number from the given String.
static java.lang.String	fillup(java.lang.String str, int len, char fillChar, boolean append) Fills the given string to the given lenght
static java.lang.String	getDuration(java.util.Date start, java.util.Date end) Creates a duration string from the given dates. Format: HHHH:MM:SS.SSSS
static java.lang.String	getExtension(java.lang.String name) Returns the extension of the given filename.
static java.lang.String	getFileSeparator()
static java.lang.String	getFirstToken(java.lang.String str) Gets the very first token in the String.
static java.lang.String	getNameWithoutExtension(java.lang.String name) Returns the given name without an extension.
static java.lang.String	getNameWithoutPath(java.lang.String name) Returns the given file without the path information.
static java.lang.String	getNextTokenAfterOpeningBrace(java.lang.String str) Gets the token after the first opening brace ('{')
static java.lang.String	getNextTokenAfterOpeningBrace(java.lang.String str, int numOpeningBrace) Gets the token after the n-th opening character
static java.lang.String	getNextTokenAfterOpeningParenthesis(java.lang.String str) Gets the token after the first opening paranthesis ('(')
static java.lang.String	getNextTokenAfterOpeningParenthesis(java.lang.String str, int numOpeningParenthesis) Gets the token after the n-th opening paranthesis ('(')
static int	getNumericStringWidth(int n) Determine how many characters this number needs
static java.lang.String	getPartAfterLastCharacter(java.lang.String txt, char ch) Gives the remaining String after the last occurrence of the character ch in the String txt.
static java.lang.String	getPathForFile(java.lang.String name) Returns the folder the given file resides.
static java.lang.String	getPostfix(IDocument document, int offset) Get the next word token (not an operator token)
static java.lang.String	getPostfix(ITextViewer viewer, int offset) This is a convienence method for getPostfix(viewer.getDocument(), offset);
static java.lang.String	getPrefix(IDocument document, int offset) Extracts the prefix.
static java.lang.String	getPrefix(ITextViewer viewer, int offset) Extracts the prefix.
static java.lang.String	getStringNullsave(java.lang.String str)
static java.lang.String	getToken(IDocument document, int offset)
static java.lang.String	getWordBelowOffset(IDocument document, int offset) Extracts the word below the given offset.
static java.lang.String	getWordBelowOffset(ITextViewer viewer, int offset) Extracts the word below the given offset.
static java.lang.String	getZeroFormattedString(int n, int width)
static boolean	isNamingCharacter(char ch) Checks if the character can be used within a povray naming sequence.
static boolean	isNumberCharacter(char ch) Checks if the character can be used witrhin us-styled number.
static boolean	isTokenCharacter(char ch) Checks if the character can be used within a povray naming sequence.
static boolean	isUSNumberCharacter(char c) Checks if a character is valid for usage in a US-style number.
static boolean	isWhitespace(char ch)
static java.lang.String	readFile(java.io.File file)
static java.lang.StringBuffer	readInputStream(java.io.InputStreamReader streamReader) Reads the given InputStreamReader and return the content as StringBuffer. In case of an exception while reading the file an empty StringBuffer is returned.
static boolean	startsWithIgnoreCase(java.lang.String str, java.lang.String start) Indicates whether str starts with the start String, ignoring the case.

Methods inherited from class java.lang.Object

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

Field Detail

STRING_ESCAPE_CHARACTER

public static char STRING_ESCAPE_CHARACTER

The escape character for String used by the Povray SDL: '\'.

Constructor Detail

StringUtils

public StringUtils()

Method Detail

fillup

public static java.lang.String fillup(java.lang.String str,
                                      int len,
                                      char fillChar,
                                      boolean append)

Fills the given string to the given lenght

Parameters:

str - The String to be filled up

len - The filled lenght

fillChar - The character to be used for filling

append - true to append the fill char at the end, false to insert it at the beginning.

Returns:

If lenght of the given String is more or equal than len str is returned unchanged, otherwise the filled String is returned.

getNameWithoutExtension

public static java.lang.String getNameWithoutExtension(java.lang.String name)

Returns the given name without an extension.

Parameters:

name - The (file) name to process.

Returns:

The name till the last occurence of "."

getExtension

public static java.lang.String getExtension(java.lang.String name)

Returns the extension of the given filename.

Parameters:

name - The (file) name to process.

Returns:

The file extension after the very last occurence of "." or an empty String if there was no dot, never null.;

getNameWithoutPath

public static java.lang.String getNameWithoutPath(java.lang.String name)

Returns the given file without the path information.

Parameters:

name - The (file) name to process.

Returns:

The name without path information (that is, everything behind the last OS-dependent file separator).

getPathForFile

public static java.lang.String getPathForFile(java.lang.String name)

Returns the folder the given file resides.

Parameters:

name - The (file) name to process.

Returns:

The folder path for the given file or the OS-dependent file separator if the file is in the root directory.

changeExtension

public static java.lang.String changeExtension(java.lang.String name,
                                               java.lang.String extension)

Exchanges the extension of the given (file) name.

Parameters:

name - The (file) name to be processed.

extension - The new extension

Returns:

The given name having the new extension.

getStringNullsave

public static java.lang.String getStringNullsave(java.lang.String str)

Parameters:

str - The String to be checked.

Returns:

Never null, if the given String is null an empty String is returned, otherwise the given string.

containsOnlySpaces

public static boolean containsOnlySpaces(java.lang.String str)

Parameters:

str - The string to be checked.

Returns:

true if the given String contains only SPACES and TABS, false if there are other characters.

ensureOnlyWhiteSpaces

public static java.lang.String ensureOnlyWhiteSpaces(java.lang.String str)

Parameters:

str - The String to be processed

Returns:

The given String having all non-SPACE and non-TAB characters being exchanged by SPACES.

isUSNumberCharacter

public static boolean isUSNumberCharacter(char c)

Checks if a character is valid for usage in a US-style number. The following characters are treated as beeing valid:

• '0' to '9'
• '.'
• '-'

Parameters:

c - The character to check

Returns:

true if the given character is a digit valid for US-style numbers, false otherwise.

extractUSNumber

public static java.lang.String extractUSNumber(java.lang.String str,
                                               int occurence)

Extracts the n-th occurence of a US-styled number from the given String.

Parameters:

str - The String containing numbers

occurence - The number having this index (1-based!) is returned

Returns:

The n-th occurence of a US-styled number or an empty String if non could be found. Never null!

extractQuotedString

public static java.lang.String extractQuotedString(java.lang.String str,
                                                   boolean includeQuotes)

Extracts everything between the first two ocurrences of a doublequote.

Parameters:

str - The String to be processed.

Returns:

The content between the first two doublequotes or an empty string in case of an failure. Never null.

extractTo

public static java.lang.String extractTo(java.lang.String str,
                                         char marker)

Extract a string up to this character. Does not include the marker.
Useful for parsing comma separated vectors. FIXME: Need to handle scanning through comments and strings

Parameters:

str - The string to extract from

marker - The character to stop at

Returns:

The text up to the marker, or the whole string if the marker doesn't exist.

extractExpression

public static java.lang.String extractExpression(java.lang.String str)

Given '#ifdef (TARGET)' return 'TARGET'
FIXME: Broken for case: #ifdef /*(*/ (foo)

Parameters:

str -

Returns:

extractParam

public static java.lang.String extractParam(java.lang.String str)

Extract a string up to the next comma. Does not include the comma.

Parameters:

str - The string to extract from

Returns:

The text up to the comma, or the whole string if the marker doesn't exist.

startsWithIgnoreCase

public static boolean startsWithIgnoreCase(java.lang.String str,
                                           java.lang.String start)

Indicates whether str starts with the start String, ignoring the case.

Parameters:

str - The String to check if it begins with start.

start - The beginning of the String

Returns:

if both strings are null or str starts with the start ignoring the case, false otherwise.

getPrefix

public static java.lang.String getPrefix(ITextViewer viewer,
                                         int offset)

Extracts the prefix. This is a convinience method for getPrefix(viewer.getDocument(), offset);

Parameters:

viewer - The viewer to operate on.

offset - The offset of the current cursor position.

Returns:

The String from the beginning of the word to the offset position.

getPrefix

public static java.lang.String getPrefix(IDocument document,
                                         int offset)

Extracts the prefix.

Parameters:

document - The document to operate on.

offset - The offset of the current cursor position.

Returns:

The String from the beginning of the word to the offset position.

isNamingCharacter

public static boolean isNamingCharacter(char ch)

Checks if the character can be used within a povray naming sequence.

Parameters:

ch - The character to be checked

Returns:

true if the character is a letter, digit or '_', false otherwise.

isNumberCharacter

public static boolean isNumberCharacter(char ch)

Checks if the character can be used witrhin us-styled number.

Parameters:

ch - The character to be checked

Returns:

true if the character is a digit, '.' or '-', false otherwise.

isTokenCharacter

public static boolean isTokenCharacter(char ch)

Checks if the character can be used within a povray naming sequence.

Parameters:

ch - The character to be checked

Returns:

true if the character is a letter, digit or one of '_', '-', '.' or '#', otherwise false.

isWhitespace

public static boolean isWhitespace(char ch)

getPostfix

public static java.lang.String getPostfix(ITextViewer viewer,
                                          int offset)

This is a convienence method for getPostfix(viewer.getDocument(), offset);

Parameters:

viewer - The viewer to operate on.

offset - The offset of work with.

Returns:

The String from the offset position to the end of the word, never null.

getPostfix

public static java.lang.String getPostfix(IDocument document,
                                          int offset)

Get the next word token (not an operator token)

Parameters:

document - The document to operate on.

offset - The offset of work with.

Returns:

The String from the offset position to the end of the word, never null.

getToken

public static java.lang.String getToken(IDocument document,
                                        int offset)

getWordBelowOffset

public static java.lang.String getWordBelowOffset(ITextViewer viewer,
                                                  int offset)

Extracts the word below the given offset.

Parameters:

viewer - The viewer to work with

offset - The offset to work with

Returns:

The word under the given offset.

getWordBelowOffset

public static java.lang.String getWordBelowOffset(IDocument document,
                                                  int offset)

Extracts the word below the given offset.

Parameters:

document - The document to work with

offset - The offset to work with

Returns:

The word under the given offset.

ensureMaxLength

public java.lang.String ensureMaxLength(java.lang.String str,
                                        int maxLen)

Ensures that the given String is never longer than the given maxLen.

Parameters:

str - The String to be checked

maxLen - The maximum allowed string lenght

Returns:

• null if str is null
• str if it's lenght is shorter than maxLen
• The first maxLen-3 characters of str followed by "..."

ensureMaxLineLength

public static java.lang.String ensureMaxLineLength(java.lang.String text,
                                                   int maxLineLen)

Inserts newlines if a line would be longer than lineLen characters. The newlines are inserted before the word making the line too long.

Parameters:

text - The text tobe processed

maxLineLen - The maximum allowed line lenght

Returns:

The changed text.

readInputStream

public static java.lang.StringBuffer readInputStream(java.io.InputStreamReader streamReader)

Reads the given InputStreamReader and return the content as StringBuffer.
In case of an exception while reading the file an empty StringBuffer is returned.

Parameters:

streamReader - The InputStreamReader to be read.

Returns:

The StringBuffer holding the stream content, never NULL.

getFileSeparator

public static java.lang.String getFileSeparator()

Returns:

The value of the system property 'file.separator'.

countChar

public static int countChar(char[] array,
                            char c)

bildPath

public static java.lang.String bildPath(java.lang.String path1,
                                        java.lang.String path2)

Builds a new path from the two given parts. Correct '/' handling between the path parts is applied.

Parameters:

path1 - The first path part

path2 - The second path part to be appended to the first one

Returns:

A new path build from the given parts.

getFirstToken

public static java.lang.String getFirstToken(java.lang.String str)

Gets the very first token in the String.

Parameters:

str - The String who's first token is to be extracted.

Returns:

The very first token.

getNextTokenAfterOpeningBrace

public static java.lang.String getNextTokenAfterOpeningBrace(java.lang.String str)

Gets the token after the first opening brace ('{')

Parameters:

str - The String to work on.

Returns:

The first token after the first opening brace ('{') or an empty String if none could be found. Never null.

getNextTokenAfterOpeningParenthesis

public static java.lang.String getNextTokenAfterOpeningParenthesis(java.lang.String str)

Gets the token after the first opening paranthesis ('(')

Parameters:

str - The String to work on.

Returns:

The first token after the first opening paranthesis ('(') or an empty String if none could be found. Never null.

getNextTokenAfterOpeningParenthesis

public static java.lang.String getNextTokenAfterOpeningParenthesis(java.lang.String str,
                                                                   int numOpeningParenthesis)

Gets the token after the n-th opening paranthesis ('(')

Parameters:

str - The String to work on.

numOpeningParenthesis - The number of opening paranthesis

Returns:

The first token after the numOpeningParenthesis opening paranthesis ('(') or an empty String if none could be found. Never null.

getNextTokenAfterOpeningBrace

public static java.lang.String getNextTokenAfterOpeningBrace(java.lang.String str,
                                                             int numOpeningBrace)

Gets the token after the n-th opening character

Parameters:

str - The String to work on.

numOpeningBrace - The number of opening braces

Returns:

The first token after the numOpeningBrace opening brace ('{') or an empty String if none could be found. Never null.

getDuration

public static java.lang.String getDuration(java.util.Date start,
                                           java.util.Date end)

Creates a duration string from the given dates.
Format: HHHH:MM:SS.SSSS

Parameters:

start - The start time

end - The end time

Returns:

The duration formatted as String.

getPartAfterLastCharacter

public static java.lang.String getPartAfterLastCharacter(java.lang.String txt,
                                                         char ch)

Gives the remaining String after the last occurrence of the character ch in the String txt.

Parameters:

txt - The Striong to work on.

ch - The character to be searched for.

Returns:

See above. If the given String is null than null is returned. If the given Strnig does not contain the character ch the complete String txt is returned.

readFile

public static java.lang.String readFile(java.io.File file)
                                 throws java.io.IOException

Throws:

java.io.IOException

getNumericStringWidth

public static int getNumericStringWidth(int n)

Determine how many characters this number needs

Parameters:

n - The number to check

Returns:

the String width of this number

getZeroFormattedString

public static java.lang.String getZeroFormattedString(int n,
                                                      int width)

extractDeclarationName

public static java.lang.String extractDeclarationName(java.lang.String str)

extractDeclarationRValue

public static java.lang.String extractDeclarationRValue(java.lang.String str)

extractMacroName

public static java.lang.String extractMacroName(java.lang.String str)