Index (BRules 1.5.0 API)

A B C H I J L O P R T U X

A

ageInYears(Date) - Static method in class routines.BRules: Calculates age in whole years based on today's date {talendTypes} Integer {Category} BRules {param} date(birthDate) input: the date of birth
ageInYears(Date, Date) - Static method in class routines.BRules: Calculates age in whole years using the specified as of date Returns null if birthDate or asOfDate is null {talendTypes} Integer {Category} BRules {param} date(birthDate) input: the date of birth {param} date(asOfDate) input: date used for comparison; alternative to today
all(Object...) - Static method in class routines.BRules: all: true if all arguments are not empty (not null for Objects, not null, empty string, or whitespace for java.lang.String) {talendTypes} String {Category} BRules {param} object() input: a variable number of params to check {example} all("one", "two", "") # false {example} all("one") # true

B

BRules - Class in routines: BRules is a collection of Java methods used for validation, formatting, and transformation.
BRules() - Constructor for class routines.BRules

C

comma(Object...) - Static method in class routines.BRules: comma: join the string representation of objects together with a comma Appends an empty string where an element is null {talendTypes} String {Category} BRules {param} object() input: a variable number of strings to join {example} comma("one", "two", "three") # "one,two,three"

H

hasJSONPath(String, String) - Static method in class routines.BRules: hasJSONPath: true if the passed-in json has elements referenced in path Not supported for JDKs < 6; will throw exception {talendTypes} String {Category} BRules {param} string("{name: 'Carl', program: 'BRules'}") input: json to be tested {example} hasJSONPath("hello") # false {example} hasJSONPath("{name: 'Carl', program: 'BRules'}", "$.name") # true {example} isJSON("{}") #true {example} hasJSONPath(null) #false
htmlList(String, String, Object...) - Static method in class routines.BRules

I

isBlank(String) - Static method in class routines.BRules: isBlank: true if the string is null, the empty string, or whitespace {talendTypes} String {Category} BRules {param} string("hello") input : string to be tested {example} isBlank("hello") # false {example} isBlank(null) # true {example} isBlank("") # true {example} isBlank(" ") # true
isJSON(String) - Static method in class routines.BRules: isJSON: true if the passed-in string adheres to JSON format Not supported for JDKs < 6; will throw exception Empty expressions - {} and [] - will return true {talendTypes} String {Category} BRules {param} string("{name: 'Carl', program: 'BRules'}") input: json to be tested {example} isJSON("hello") # false {example} isJSON("{name: 'Carl', program: 'BRules'}") # true {example} isJSON("{}") #true {example} isJSON(null) #false
isPhoneNum(String, String) - Static method in class routines.BRules: isPhoneNum: true if valid in accordance with country specifier; uses strict check {talendTypes} String {Category} BRules {param} string("regionCode") input: The country or region code to use {param} string("phoneNumber") input: The phone number to check {example} isPhoneNum("US", "(301) 555-5555") # true
isPhoneNum(String, String, boolean) - Static method in class routines.BRules: isPhoneNum: true if valid in accordance with country specifier and loose flag (false for strict) {talendTypes} String {Category} BRules {param} string("regionCode") input: The country or region code to use {param} string("phoneNumber") input: The phone number to check {param} boolean: use loose validation (true) or strict (false) {example} isPhoneNum("US", "(301) 555-5555") # true
isXML(String, String) - Static method in class routines.BRules: isXML: true if the passed-in string adheres to XML well-formedness and the specified charset {talendTypes} String {Category} BRules {param} string("hello") input: xml to be tested {param} string("ISO8859_1") input: the charset of the xml {example} isXML("hello", "ISO8859_1") # true {example} isXML("hello", "ISO8859_1") # false
isXML(String) - Static method in class routines.BRules: isXML: true if the passed-in string adheres to XML well-formedness using a UTF-8 string {talendTypes} String {Category} BRules {param} string("hello") input: xml to be tested {example} isXML("hello") # true {example} isXML("hello") # false

J

join(String, Object...) - Static method in class routines.BRules: join: join the string representation of objects together with a character Appends an empty string where an element is null {talendTypes} String {Category} BRules {param} object() input: a variable number of strings to join {example} join("one", "two", "three") # "one,two,three"

L

listToString(List<?>) - Static method in class routines.BRules: Forms a comma-separated list given the input java.util.List Handles different types Nulls are skipped, for example [A, null, B] -> A,,B {talendTypes} String {Category} BRules {param} list(inputList) input: the list to convert
listToString(List<?>, String) - Static method in class routines.BRules: Forms a comma-separated list given the input java.util.List using the specified delimeter Handles different types Nulls are skipped, for example [A, null, B] -> A,,B {talendTypes} String {Category} BRules {param} list(inputList) input: the list to convert {param} string(delimiter) input: delimiter to used in string separating items
listToString(List<?>, String, String) - Static method in class routines.BRules: Forms a comma-separated list given the input java.util.List Handles different types Nulls are skipped, for example [A, null, B] -> A,,B {talendTypes} String {Category} BRules {param} list(inputList) input: the list to convert {param} string(delimiter) input: delimiter to used in string separating items {param} string(escapeString) input: string to wrap each item

O

okChars(String, String) - Static method in class routines.BRules: okChars: true if the passed-in string is valid for the specified character set The supported character set values are those supported by Java.
ol(String, Object...) - Static method in class routines.BRules: ol: form an html list of the specified css style from the list of objects null objects returns an empty list (ex, "") {talendTypes} String {Category} BRules {param} styleClass : a style to apply for the toplevel list element {param} object() input: a variable number of strings to join {example} ol("infolist", "a", "b") # "ab"

P

p(String, String) - Static method in class routines.BRules: p: form an html paragraph of the specified css style from the list of objects null objects returns an empty list (ex, "
pad(String) - Static method in class routines.BRules: Deprecated.
pad(String, int) - Static method in class routines.BRules: Left pads the input string with spaces {talendTypes} String {Category} BRules {param} string(stringToPad) stringToPad: string to pad {param} int(numPadChars) numPadChars: number of padded chars {example} pad("100",6) # "000100"
pad(String, int, char) - Static method in class routines.BRules: Left pads the input string with the specified character {talendTypes} String {Category} BRules {param} string(stringToPad) stringToPad: string to pad {param} int(numPadChars) numPadChars: number of padded chars {param} char(charToUse) charToUse: char to use as padding {example} pad("100", 6, '0') # "000100"
pad(Integer, int, char) - Static method in class routines.BRules: Left pads the input integer with the specified character {talendTypes} String {Category} BRules {param} int(integerToPad) integerToPad: int to pad {param} int(numPadChars) numPadChars: number of padded chars {param} char(charToUse) charToUse: char to use as padding {example} pad(100, 6, '0') # "000100"
pad(Long, int, char) - Static method in class routines.BRules: Left pads the input long with the specified character {talendTypes} String {Category} BRules {param} long(integerToPad) integerToPad: int to pad {param} long(numPadChars) numPadChars: number of padded chars {param} char(charToUse) charToUse: char to use as padding {example} pad(100L, 6, '0') # "000100"
padRight(String, int) - Static method in class routines.BRules: Right pads the input string with spaces {talendTypes} String {Category} BRules {param} string(stringToPad) stringToPad: string to pad {param} int(numPadChars) numPadChars: number of padded chars {example} pad("100", 6) # "100 "
padRight(String, int, char) - Static method in class routines.BRules: Right pads the input string with the specified character {talendTypes} String {Category} BRules {param} string(stringToPad) stringToPad: string to pad {param} int(numPadChars) numPadChars: number of padded chars {param} char(charToUse) charToUse: char to use as padding {example} pad("100", 6, '0') # "100000"

R

routines - package routines

T

toCharset(String) - Static method in class routines.BRules: toCharset: convert a string to the character set used by Windows Latin-1.
toCharset(String, String) - Static method in class routines.BRules: toCharset: convert a string to the specified character set Will convert unmappable characters to a space (" ") rather than throwing an error For example, this will conveniently map a ™ (TM) symbol to a Windows-recognized hex 99 Uses Java names for charsets: Cp1252, US-ASCII {talendTypes} String {Category} BRules {param} string(_s) input string to convert {param} string(_charset) character set to use for conversion {example} toCharset("My Product™", "Cp1252") # returns "My Product "
toCharset(String, String, String) - Static method in class routines.BRules: toCharset: convert a string to the specified character set Will convert unmappable characters to a specified character For example, this will conveniently map a ™ (TM) symbol to a Windows-recognized hex 99 Uses Java names for charsets: Cp1252, US-ASCII, ISO-8859-1, UTF-8, UTF-16 {talendTypes} String {Category} BRules {param} string(_s) input string to convert {param} string(_charset) character set to use for conversion {param} string(_replaceCh) character to use for unmappables {example} toCharset("My Product™", "Cp1252", "?") # returns "My Product?"
trimLeadingZeros(String) - Static method in class routines.BRules: Take off leading zeros; assumes a number {talendTypes} String {Category} BRules {param} trimLeadingZeros(string) input: The string to be divided

U

ul(String, Object...) - Static method in class routines.BRules: ul: form an html list of the specified css style from the list of objects null objects returns an empty list (ex, "") {talendTypes} String {Category} BRules {param} styleClass : a style to apply for the toplevel list element {param} object() input: a variable number of strings to join {example} ul("infolist", "a", "b") # "ab"

X

xor(Object...) - Static method in class routines.BRules: xor: true if one and only one argument is not empty (not null for Objects, not null, empty string, or whitespace for java.lang.String) {talendTypes} String {Category} BRules {param} object() input: a variable number of params to check {example} xor("one", "") # true {example} xor("", "") # false

A B C H I J L O P R T U X