StringUtil (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.camunda.bpm.engine.impl.util.StringUtil

public final class StringUtil
extends Object

Author:: Sebastian Menski

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StringUtil.StringIterator<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`StringUtil.StringIterator<T>`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DB_MAX_STRING_LENGTH` Note: `String.length()` counts Unicode supplementary characters twice, so for a String consisting only of those, the limit is effectively MAX_LONG_STRING_LENGTH / 2

Constructor Summary

Constructors
Constructor and Description

StringUtil()

Constructors
Constructor and Description
`StringUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`fromBytes(byte[] bytes)` Converts a byte array into a string using the current process engines default charset as returned by `ProcessEngineConfigurationImpl.getDefaultCharset()`.
`static String`	`fromBytes(byte[] bytes, ProcessEngine processEngine)` Converts a byte array into a string using the current process engines default charset as returned by `ProcessEngineConfigurationImpl.getDefaultCharset()`.
`static boolean`	`hasAnySuffix(String text, String[] suffixes)`
`static boolean`	`hasText(String string)`
`static boolean`	`isCompositeExpression(String text, ExpressionManager expressionManager)` Checks whether a `String` seams to be a composite expression or not.
`static boolean`	`isExpression(String text)` Checks whether a `String` seams to be an expression or not Note: In most cases you should check for composite expressions.
`static String`	`join(Iterator<String> iterator)`
`static String`	`joinDbEntityIds(Collection<? extends DbEntity> dbEntities)`
`static String`	`joinProcessElementInstanceIds(Collection<? extends ProcessElementInstance> processElementInstances)`
`static Reader`	`readerFromBytes(byte[] bytes)`
`static String[]`	`split(String text, String regex)`
`static byte[]`	`toByteArray(String string)` Gets the bytes from a string using the current process engine's default charset
`static byte[]`	`toByteArray(String string, ProcessEngine processEngine)` Gets the bytes from a string using the provided process engine's default charset
`static String`	`trimToMaximumLengthAllowed(String string)` Trims the input to the `maxium length allowed` for persistence with our default database schema
`static Writer`	`writerForStream(OutputStream outStream)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DB_MAX_STRING_LENGTH
```
public static int DB_MAX_STRING_LENGTH
```
    Note: String.length() counts Unicode supplementary characters twice, so for a String consisting only of those, the limit is effectively MAX_LONG_STRING_LENGTH / 2
- Constructor Detail
  - StringUtil
```
public StringUtil()
```
- Method Detail
  - isExpression
```
public static boolean isExpression(String text)
```
    Checks whether a String seams to be an expression or not Note: In most cases you should check for composite expressions. See isCompositeExpression(String, ExpressionManager) for more information.
    
    Parameters:
    
    text - the text to check
    
    Returns:
    
    true if the text seams to be an expression false otherwise
  - isCompositeExpression
```
public static boolean isCompositeExpression(String text,
                                            ExpressionManager expressionManager)
```
    Checks whether a String seams to be a composite expression or not. In contrast to an eval expression is the composite expression also allowed to consist of a combination of literal and eval expressions, e.g., "Welcome ${customer.name} to our site". Note: If you just want to allow eval expression, then the expression must always start with "#{" or "${". Use isExpression(String) to conduct these kind of checks.
  - split
```
public static String[] split(String text,
                             String regex)
```
  - hasAnySuffix
```
public static boolean hasAnySuffix(String text,
                                   String[] suffixes)
```
  - fromBytes
```
public static String fromBytes(byte[] bytes)
```
    Converts a byte array into a string using the current process engines default charset as returned by ProcessEngineConfigurationImpl.getDefaultCharset(). The converted string is empty if the provided byte array is empty or null.
    
    Parameters:
    
    bytes - the byte array
    
    Returns:
    
    a string representing the bytes, empty String if byte array is null
  - fromBytes
```
public static String fromBytes(byte[] bytes,
                               ProcessEngine processEngine)
```
    Converts a byte array into a string using the current process engines default charset as returned by ProcessEngineConfigurationImpl.getDefaultCharset(). The converted string is empty if the provided byte array is empty or null.
    
    Parameters:
    
    bytes - the byte array
    
    processEngine - the process engine
    
    Returns:
    
    a string representing the bytes, empty String if byte array is null
  - readerFromBytes
```
public static Reader readerFromBytes(byte[] bytes)
```
  - writerForStream
```
public static Writer writerForStream(OutputStream outStream)
```
  - toByteArray
```
public static byte[] toByteArray(String string)
```
    Gets the bytes from a string using the current process engine's default charset
    
    Parameters:
    
    string - the string to get the bytes form
    
    Returns:
    
    the byte array
  - toByteArray
```
public static byte[] toByteArray(String string,
                                 ProcessEngine processEngine)
```
    Gets the bytes from a string using the provided process engine's default charset
    
    Parameters:
    
    string - the string to get the bytes form
    
    processEngine - the process engine to use
    
    Returns:
    
    the byte array
  - trimToMaximumLengthAllowed
```
public static String trimToMaximumLengthAllowed(String string)
```
    Trims the input to the maxium length allowed for persistence with our default database schema
    
    Parameters:
    
    string - the input that might be trimmed if maximum length is exceeded
    
    Returns:
    
    the input, eventually trimmed to DB_MAX_STRING_LENGTH
  - joinDbEntityIds
```
public static String joinDbEntityIds(Collection<? extends DbEntity> dbEntities)
```
  - joinProcessElementInstanceIds
```
public static String joinProcessElementInstanceIds(Collection<? extends ProcessElementInstance> processElementInstances)
```
  - hasText
```
public static boolean hasText(String string)
```
    Parameters:
    
    string - the String to check.
    
    Returns:
    
    a boolean TRUE if the String is not null and not empty. FALSE otherwise.
  - join
```
public static String join(Iterator<String> iterator)
```

Class StringUtil

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DB_MAX_STRING_LENGTH

Constructor Detail

StringUtil

Method Detail

isExpression

isCompositeExpression

split

hasAnySuffix

fromBytes

fromBytes

readerFromBytes

writerForStream

toByteArray

toByteArray

trimToMaximumLengthAllowed

joinDbEntityIds

joinProcessElementInstanceIds

hasText

join