String data type

Value range of the String data type

FirstSpirit makes the data type String available for editing values which represent a fixed or variable length text. A string contains a character string consisting of a sequence of characters (e.g. letters, digits, special characters and control characters) from a defined character set. The order of the characters is defined by the character chain. All characters can be repeated within a character chain as many times as required.

The data type string can also be looked up in the Java API documentation:

java.lang.String

Definition

In FirstSpirit, when a string is defined a string object in the class java.lang.String is generated.

$CMS_SET(myString, "That is a text.")$

Definition using the standard input components

Within the form area of templates, input components are defined which can be subsequently used by the editors to insert the actual editorial contents into the page. The standard input components supported by FirstSpirit return different data types.

The following standard input components return an object of data type string:

• CMS_INPUT_TEXT
• CMS_INPUT_TEXTAREA

With the help of a $CMS_VALUE(...)$ instruction, methods can then be applied to this object:

$CMS_VALUE(IDENTIFIER.METHOD)$

Methods on string objects

The table below lists all methods which can be invoked on objects of data type string.

charAt(int)

Overview

charAt(Number)

Overview

chars

Overview

codePointAt(int)

Overview

codePointBefore(int)

Overview

codePointCount(int, int)

Overview

codePoints

Overview

compare(CharSequence, CharSequence)

Overview

compareTo(String)

The .compareTo(String) (in Bean syntax: .compareTo(String)) method returns a lexicographic comparison of two strings (cf. java.lang.String). The method returns a positive value if the string is lexicographically larger than the transferred string and a negative value if the string is lexicographically smaller. The method returns 0 if the transferred string is identical to the invoking string.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.compareTo("Das ist ein String"))$

Output:

1

Overview

compareTo(CharSequence)

Overview

compareTo(Object)

Overview

compareToIgnoreCase(String)

Overview

concat(String)

Overview

contains(String)

The .contains(String) (in Bean syntax: .contains(String)) method returns true if the transferred sub-string is found in the character string at least once or false if the sub-string is not found (cf. java.lang.String). It is case sensitive, i.e. a differentiation is made between upper and lower case letters.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.contains("ein"))$

Output:

true

Overview

contains(CharSequence)

Overview

contentEquals(StringBuffer)

Overview

contentEquals(CharSequence)

Overview

convert

The .convert() (in Bean syntax: .convert) converts special characters contained in a character string into HTML characters for the output. When using .convert() the conversion rules in the convert area of the selected conversion rule of the template set are used.

Overview

convert(String)

Overview

convert2

The .convert2() (in Bean syntax: .convert2) converts special characters contained in a character string into HTML characters for the output. When using .convert2() the conversion rules in the convert and quote area of the selected conversion rule of the template set are used.

Overview

convert2(String)

Overview

copyValueOf(char[])

Overview

copyValueOf(char[], int, int)

Overview

describeConstable

Overview

encode

Overview

endsWith(String)

Overview

equals(String)

The .equals(String) (in Bean syntax: .equals(String)) method checks whether a string is the same as a transferred string (cf. java.lang.String). It is case sensitive, i.e. a differentiation is made between upper and lower case letters.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.equals("Das ist ein String."))$

Output:

true

Overview

equals(Option)

Overview

equals(CharSequence)

Overview

equals(Object)

Overview

equalsIgnoreCase(String)

The .equalsIgnoreCase(String) (in Bean syntax: .equalsIgnoreCase(String)) method checks whether a string is the same as a transferred string (cf. java.lang.String). There is no - unlike the .equals(String) method - case sensitivity, i.e. there is no differentiation between upper and lower case letters.

Invocation:

$CMS_SET(myString, "DAS ist EIN String.")$
$CMS_VALUE(myString.equals("Das ist ein String."))$

Output:

true

Overview

format(String, Object[])

Overview

format(Locale, String, Object[])

Overview

formatted(Object[])

Overview

get(Range)

Overview

get(Number)

Overview

getBytes

Overview

getBytes(Charset)

Overview

getBytes(String)

Overview

getChars(int, int, char[], int)

Overview

getClass

The .getClass() (in Bean syntax: .class) method returns the class of the invoking object (cf. java.lang.Class).

Invocation:

$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$

Output:

java.lang.String

Overview

getExtension

Overview

hashCode

Overview

indent(int)

Overview

indexOf(int)

Overview

indexOf(String)

The .indexOf(String) (in Bean syntax: .indexOf(String)) method returns an index of the character string at which the first character of a sub-string is found or -1 if the transferred sub-string is not found in the character string (cf. java.lang.String). It is case sensitive, i.e. a differentiation is made between upper and lower case letters.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.indexOf("ein")$

Output:

8

Overview

indexOf(int, int)

Overview

indexOf(String, int)

Overview

intern

Overview

isBlank

Overview

isCase(String)

Overview

isCase(Option)

Overview

isCase(CharSequence)

Overview

isCase(Object)

Overview

isEmpty

Overview

isLower

Overview

isNull

The .isNull() (in Bean syntax: .isNull) method checks whether an expression or object is null , e.g. storeElement.isNull(). In the case of objects with complex values or objects, the object decides when it is null. The data type DomElement for example always contains an empty document, thus it is never null. For this reason, checking an empty DOM editor input component by using the method .isNull() returns the value false, whereas checking the component with .isEmpty() would return the value true.

The method .isNull() returns a Boolean value as the check result. true is the check result if the expression or object is null and false if not.

Overview

isUpper

Overview

iterator

Overview

join(CharSequence, CharSequence[])

Overview

join(CharSequence, Iterable)

Overview

lastIndexOf(int)

Overview

lastIndexOf(String)

The .lastIndexOf(String) (in Bean syntax: .lastIndexOf(String)) method returns an index of the character string at which the first character of a sub-string is found or -1 if the transferred sub-string is not found in the character string (cf. java.lang.String). It is case sensitive, i.e. a differentiation is made between upper and lower case letters.

Unlike the .indexOf(String) method the index of the last and not the first occurrence is returned.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.lastIndexOf("ein")$

Output:

8

Overview

lastIndexOf(int, int)

Overview

lastIndexOf(String, int)

Overview

length

The .length() (in Bean syntax: .length) method returns the number of characters that exist in a character string (cf. java.lang.String or java.lang.CharSequence).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.length)$

Output:

19

Overview

lines

Overview

lowerCase

The .lowerCase() (in Bean syntax: .lowerCase) method converts all characters in the character string into lower case letters (cf. java.lang.String).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.lowerCase)$

Output:

that is a string.

Overview

matches(String)

Overview

offsetByCodePoints(int, int)

Overview

parse

Overview

parseExpression

Overview

plain

Overview

plus(Printable)

Overview

print

Overview

quoteJS

Overview

regionMatches(int, String, int, int)

Overview

regionMatches(boolean, int, String, int, int)

Overview

repeat(int)

Overview

replace(char, char)

Overview

replace(CharSequence, CharSequence)

Overview

replaceAll(String, String)

Overview

replaceFirst(String, String)

Overview

resolveConstantDesc(MethodHandles$Lookup)

Overview

sentences

Overview

set(String, Object)

Overview

set(Number, CharSequence)

Overview

split(String)

Overview

split(String, int)

Overview

split(String, Number)

Overview

startsWith(String)

The method checks whether a string of characters (e.g. a text) starts with a special character string, also refer to java.lang.String

The check starts with the first character. To have the check start at a different character in the text, this can be done using the startsWith(String, int) method.

This method returns a Boolean value as the result of the check. The check is true if the saved text matches the string of characters specified in the method and false if it does not.

Example:
The following example checks whether the input starts with the string "Hello". If it does not, a "Hello" is placed in front of the output.

$CMS_IF(!text.startsWith("Hello"))$
 Hello $CMS_VALUE(text)$

 $CMS_ELSE$
  $CMS_VALUE(text)$

$CMS_END_IF$

If Hello Anna is the input, then the output is not changed:

Hello Anna

If only Anna has been entered, "Hello" is added. The output is then

Hello Anna

Overview

startsWith(String, int)

This method checks whether a saved text contains a special string at a particular location, also refer to java.lang.String

The passed number (int) specifies at which character the check should proceed. The counting starts with 0; the location of the first character of the text to be checked is therefore 0, the second is 1, etc.

This method returns a Boolean value as the result of the check. The check is true if the saved text matches the string specified in the method at the specified location and false if it does not.

For instance, the following syntax can be used to check whether the second and third characters of the text input in a text input component is "al":

Are the second and third character of the entered text "al"? </br>
$CMS_IF(text.startsWith("al", 1))$
    => That's right.
$CMS_ELSE$
    => That's wrong.
$CMS_END_IF$

If the text saved in the text variable is false, "=> That's right." is output; otherwise, "=> That's wrong." is output.

Overview

strip

Overview

stripIndent

Overview

stripLeading

Overview

stripTrailing

Overview

subSequence(int, int)

Overview

subString(Number)

The .subString(Number) (in Bean syntax: .subString(Number)) outputs a sub-character string (cf. java.lang.String). The transferred number specified from which character the output should start (= first character).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.subString(1))$

Output:

as ist ein String.

Overview

subString(int, int)

Overview

subString(Number, Number)

The .subString(Number, Number) (in Bean syntax: .subString(Number, Number)) method outputs a sub-character string (cf. java.lang.String). The first transferred number specifies from which character (first character) and the second number up to which character (last character) the character string is to be output.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.subString(1, 12))$

Output:

as ist ein

Overview

substring(int)

The .substring(int) (in Bean syntax: .substring(int)) method outputs a sub-character string (cf. java.lang.String). The transferred number specified from which character the output should start (= first character).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1))$

Output:

as ist ein String.

Overview

substring(Number)

The .substring(Number) (in Bean syntax: .substring(Number)) outputs a sub-character string (cf. java.lang.String). The transferred number specified from which character the output should start (= first character).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1))$

Output:

as ist ein String.

Overview

substring(int, int)

The .substring(int, int) (in Bean syntax: .substring(int, int)) method outputs a sub-character string (cf. java.lang.String). The first transferred number specifies from which character (first character) and the second number up to which character (last character) the character string is to be output.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1, 12))$

Output:

as ist ein

Overview

substring(Number, Number)

The .substring(Number, Number) (in Bean syntax: .substring(Number, Number)) method outputs a sub-character string (cf. java.lang.String). The first transferred number specifies from which character (first character) and the second number up to which character (last character) the character string is to be output.

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.substring(1, 12))$

Output:

as ist ein

Overview

toCharArray

Overview

toDate(String)

Overview

toJSON

Overview

toLowerCase

The .toLowerCase() (in Bean syntax: .toLowerCase) method converts all characters in the character string into lower case letters (cf. java.lang.String).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.toLowerCase())$

Output:

that is a string.

Overview

toLowerCase(Locale)

Overview

toNumber

The .toNumber() (in Bean syntax: .toNumber) method converts the data type string (character string) into the data type Number (cf. java.lang.String). This is only possible if the character chain consists of digits.

Invocation:

$CMS_VALUE("5".toNumber())$

Output:

5

Overview

toString

Overview

toUpperCase

The .toUpperCase() (in Bean syntax: .toUpperCase) method converts all characters in the character string into upper case letters (cf. java.lang.String).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.toUpperCase())$

Output:

THAT IS A STRING.

Overview

toUpperCase(Locale)

Overview

transform(Function)

Overview

translateEscapes

Overview

trim

The .trim() (in Bean syntax: .trim) method removes whitespaces at the beginning and at the end of the character string (cf. java.lang.String).

Invocation:

$CMS_SET(myString, "\tDas ist ein String.\n")$
$CMS_VALUE(myString.trim())$

Output:

That is a string.

Overview

type

Overview

upperCase

The .upperCase() (in Bean syntax: .upperCase()) method converts all characters in the character string into upper case letters (cf. java.lang.String).

Invocation:

$CMS_SET(myString, "Das ist ein String.")$
$CMS_VALUE(myString.upperCase)$

Output:

THAT IS A STRING.

Overview

urlEncode

The .urlEncode() (in Bean syntax: .urlEncode) method can be used to convert a character string into ASCII character sequences. The conversion is also called encode or encoding. A % symbol followed by two characters is typical for such character sequences. The MIME type for a converted character string is application/x-www-form-urlencoded.

The following characters are not taken into account in the conversion:

A-Z  a-z 0-9 . - * _

Space characters are converted into plus signs.

The following encoding is used for the conversion: UTF-8.

The invocation:

$CMS_VALUE("Müller@e-Spirit.com".urlEncode)$

results in the converted character string:

M%C3%BCller%40e-Spirit.com

Cf. also java.net.URLEncoder

Overview

urlEncode(String)

The .urlEncode() (in Bean syntax: .urlEncode) method can be used to convert a character string into ASCII character sequences. The conversion is also called encode or encoding. A % symbol followed by two characters is typical for such character sequences. The MIME type for a converted character string is application/x-www-form-urlencoded.

.urlEncode() uses UTF-8 for the conversion.
Use .urlEncode(String) to indicate a special encoding.

For example, the invocation

$CMS_VALUE("Müller@e-Spirit.com".urlEncode("ISO-8859-1"))$

results in the converted character string:

M%FCller%40e-Spirit.com

Overview

valueOf(long)

Overview

valueOf(int)

Overview

valueOf(float)

Overview

valueOf(double)

Overview

valueOf(char)

Overview

valueOf(boolean)

Overview

valueOf(char[])

Overview

valueOf(Object)

Overview

valueOf(char[], int, int)

Overview

words

Overview

xmlEscape

Overview