com.github.vincentrussell.json.datagenerator.functions.impl

Class Substring

java.lang.Object

com.github.vincentrussell.json.datagenerator.functions.impl.Substring

@Function(name="substring")
public class Substring
extends Object

get substring from other string

Constructor Summary

Constructors

Constructor and Description
Substring()

Method Summary

Modifier and Type	Method and Description
String	substring(String value, String beginIndex) Returns a string that is a substring of this string.
String	substring(String value, String beginIndex, String endIndex) Returns a string that is a substring of this string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Substring

public Substring()

Method Detail

substring

@FunctionInvocation
public String substring(String value,
                                            String beginIndex)

Returns a string that is a substring of this string. The substring begins with the character at the specified index and extends to the end of this string.

Examples:

 "unhappy".substring(2) returns "happy"
 "Harbison".substring(3) returns "bison"
 "emptiness".substring(9) returns "" (an empty string)
 

Parameters:

value - string

beginIndex - the beginning index, inclusive.

Returns:

the result

substring

@FunctionInvocation
public String substring(String value,
                                            String beginIndex,
                                            String endIndex)

Returns a string that is a substring of this string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex.

Examples:

 "hamburger".substring(4, 8) returns "urge"
 "smiles".substring(1, 5) returns "mile"
 

Parameters:

value - the string

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive

Returns:

the result