Top Description Fields Constructors Methods
org.apache.poi.ss.formula.atp

pack-priv final Class TextJoinFunction

extends Object
implements FreeRefFunction
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.FreeRefFunction
Imports
org.apache.poi.ss.formula.OperationEvaluationContext, org.apache.poi.ss.formula.eval.*, org.apache.poi.ss.formula.functions.FreeRefFunction, java.util.ArrayList, .Collections, .List

Implementation of Excel function TEXTJOIN() Syntax
TEXTJOIN(delimiter, ignore_empty, text1, [text2], ...)

delimiter A text string, either empty, or one or more characters enclosed by double quotes, or a reference to a valid text string. If a number is supplied, it will be treated as text.
ignore_empty If TRUE, ignores empty cells.
text1 Text item to be joined. A text string, or array of strings, such as a range of cells.
text2 ... Optional. Additional text items to be joined. There can be a maximum of 252 text arguments for the text items, including text1. Each can be a text string, or array of strings, such as a range of cells.

Since
POI 5.1.0

Field Summary

Modifier and TypeField and Description
private ArgumentsEvaluator
public static final FreeRefFunction

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public ValueEval
evaluate(ValueEval[]
the pre-evaluated arguments for this function. args is never null, nor are any of its elements.
args
,
OperationEvaluationContext
primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.
ec
)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

private List<ValueEval>
getValues(ValueEval eval, int srcRowIndex, int srcColumnIndex, boolean lastRowOnly)

private String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

evaluatorback to summary
private ArgumentsEvaluator evaluator
instanceback to summary
public static final FreeRefFunction instance

Constructor Detail

TextJoinFunctionback to summary
private TextJoinFunction(ArgumentsEvaluator anEvaluator)

Method Detail

evaluateback to summary
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

Parameters
args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

ec:OperationEvaluationContext

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).

getValuesback to summary
private List<ValueEval> getValues(ValueEval eval, int srcRowIndex, int srcColumnIndex, boolean lastRowOnly) throws EvaluationException
laxValueToStringback to summary
private String laxValueToString(ValueEval eval)