Package com.igormaznitsa.jcp.expression.functions

Class FunctionBINFILE

java.lang.Object

com.igormaznitsa.jcp.expression.functions.AbstractFunction

com.igormaznitsa.jcp.expression.functions.FunctionBINFILE

All Implemented Interfaces:

ExpressionItem

public class FunctionBINFILE
extends AbstractFunction

The Function loads bin file and encodes it into string.

Since:

6.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	FunctionBINFILE.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final ValueType[][]	ARG_TYPES

Fields inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction

ALL_FUNCTIONS, EXECUTION_PREFIX, FUNCTION_NAME_MAP, UID_COUNTER

Constructor Summary

Constructors

Constructor	Description
FunctionBINFILE()

Method Summary

Modifier and Type	Method	Description
private static String	convertTo(File file, FunctionBINFILE.Type type, boolean deflate, int lineLength, String endOfLine)
private static byte[]	deflate(byte[] data)
Value	executeStrStr(PreprocessorContext context, Value strfilePath, Value encodeType)
ValueType[][]	getAllowedArgumentTypes()	Get arrays of supported argument types
int	getArity()	Get the function arity
String	getName()	Get the function name
String	getReference()	Get the function reference to be output for a help request
ValueType	getResultType()	Get the result type
private static boolean	hasDeflateFlag(String name, FunctionBINFILE.Type type)
private static boolean	hasSplitFlag(String name, FunctionBINFILE.Type type)

Methods inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction

findForClass, findForName, getExpressionItemPriority, getExpressionItemType, toString

Methods inherited from class java.lang.Object

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

Field Details

ARG_TYPES

private static final ValueType[][] ARG_TYPES

Constructor Details

FunctionBINFILE

public FunctionBINFILE()

Method Details

hasSplitFlag

private static boolean hasSplitFlag(String name,
 FunctionBINFILE.Type type)

hasDeflateFlag

private static boolean hasDeflateFlag(String name,
 FunctionBINFILE.Type type)

getName

public String getName()

Description copied from class: AbstractFunction

Get the function name

Specified by:

getName in class AbstractFunction

Returns:

the function name in lower case, must not be null

getReference

public String getReference()

Description copied from class: AbstractFunction

Get the function reference to be output for a help request

Specified by:

getReference in class AbstractFunction

Returns:

the function information as a String, must not be null

getArity

public int getArity()

Description copied from class: AbstractFunction

Get the function arity

Specified by:

getArity in class AbstractFunction

Returns:

the function arity (zero or greater)

getAllowedArgumentTypes

@MustNotContainNull
public ValueType[][] getAllowedArgumentTypes()

Description copied from class: AbstractFunction

Get arrays of supported argument types

Specified by:

getAllowedArgumentTypes in class AbstractFunction

Returns:

the array of argument type combinations allowed by the function handler, must not be null

getResultType

public ValueType getResultType()

Description copied from class: AbstractFunction

Get the result type

Specified by:

getResultType in class AbstractFunction

Returns:

the result type of the function, must not be null

executeStrStr

public Value executeStrStr(PreprocessorContext context,
 Value strfilePath,
 Value encodeType)

convertTo

private static String convertTo(File file,
 FunctionBINFILE.Type type,
 boolean deflate,
 int lineLength,
 String endOfLine)
                         throws IOException

Throws:

IOException

deflate

private static byte[] deflate(byte[] data)
                       throws IOException

Throws:

IOException