Package com.api.jsonata4java.expressions.functions

Class PadFunction

java.lang.Object

com.api.jsonata4java.expressions.functions.FunctionBase

com.api.jsonata4java.expressions.functions.PadFunction

All Implemented Interfaces:

Function, Serializable

public class PadFunction
extends FunctionBase
implements Function

From http://docs.jsonata.org/string-functions.html: $pad(str, width [, char]) Returns a copy of the string str with extra padding, if necessary, so that its total number of characters is at least the absolute value of the width parameter. If width is a positive number, then the string is padded to the right; if negative, it is padded to the left. The optional char argument specifies the padding character(s) to use. If not specified, it defaults to the space character. Examples $pad("foo", 5)=="foo " $pad("foo", -5)==" foo" $pad("foo", -5, "#") == "##foo" $formatBase(35, 2) ~> $pad(-8, '0')=="00100011"

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERR_ARG1BADTYPE
static String	ERR_ARG2BADTYPE
static String	ERR_ARG3BADTYPE
static String	ERR_ARG4BADTYPE
static String	ERR_BAD_CONTEXT

Constructor Summary

Constructors

Constructor	Description
PadFunction()

Method Summary

Modifier and Type	Method	Description
int	getMaxArgs()
int	getMinArgs()
String	getSignature()
com.fasterxml.jackson.databind.JsonNode	invoke(ExpressionsVisitor expressionVisitor, MappingExpressionParser.Function_callContext ctx)
static String	leftPad(String str, int size, String padStr)
static String	rightPad(String str, int size, String padStr)

Methods inherited from class com.api.jsonata4java.expressions.functions.FunctionBase

getArgumentCount, getFunctionName

Methods inherited from class java.lang.Object

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

Field Detail

ERR_BAD_CONTEXT

public static String ERR_BAD_CONTEXT

ERR_ARG1BADTYPE

public static String ERR_ARG1BADTYPE

ERR_ARG2BADTYPE

public static String ERR_ARG2BADTYPE

ERR_ARG3BADTYPE

public static String ERR_ARG3BADTYPE

ERR_ARG4BADTYPE

public static String ERR_ARG4BADTYPE

Constructor Detail

PadFunction

public PadFunction()

Method Detail

invoke

public com.fasterxml.jackson.databind.JsonNode invoke(ExpressionsVisitor expressionVisitor,
                                                      MappingExpressionParser.Function_callContext ctx)

Specified by:

invoke in interface Function

leftPad

public static String leftPad(String str,
                             int size,
                             String padStr)

rightPad

public static String rightPad(String str,
                              int size,
                              String padStr)

getMaxArgs

public int getMaxArgs()

Specified by:

getMaxArgs in interface Function

getMinArgs

public int getMinArgs()

Specified by:

getMinArgs in interface Function

getSignature

public String getSignature()

Specified by:

getSignature in interface Function