com.dkfqs.tools.text

Class ReplaceVariableLiteralsInBinaryContent

java.lang.Object

com.dkfqs.tools.text.ReplaceVariableLiteralsInBinaryContent

public class ReplaceVariableLiteralsInBinaryContent
extends java.lang.Object

Replace Variable Literals (placeholders) in a binary content.

Programming Example:

byte[] content = "The US$ ${amount} billion bilateral trade target between ${country1} and ${country2} set for this year will not be reached.".getBytes(StandardCharsets.UTF_8);
HashMap<String, String> nameValueMap = new HashMap<String, String>();
nameValueMap.put("amount", "15");
nameValueMap.put("country1", "Cambodia");
nameValueMap.put("country2", "Thailand");

ReplaceVariableLiteralsInBinaryContent replaceVariableLiteralsInBinaryContent = new ReplaceVariableLiteralsInBinaryContent(content, nameValueMap);
boolean allOk = replaceVariableLiteralsInBinaryContent.execute();
System.out.println(new String(replaceVariableLiteralsInBinaryContent.getResultContent(), StandardCharsets.UTF_8));  // The US$ 15 billion bilateral trade target between Cambodia and Thailand set for this year will not be reached.

System.out.println("successfulReplaces = " + replaceVariableLiteralsInBinaryContent.getNumSuccessfulReplaces());
System.out.println("failedReplaces = " + replaceVariableLiteralsInBinaryContent.getNumFailedReplaces());
System.out.println("allOk = " + allOk);
if (!allOk) {
   for (String contentVarName : replaceVariableLiteralsInBinaryContent.getFailedReplaceVariablesList()) {
      System.out.println("- Failed to replace var " + new String(replaceVariableLiteralsInBinaryContent.getLeftSidePattern(), StandardCharsets.UTF_8) + contentVarName + new String(replaceVariableLiteralsInBinaryContent.getRightSidePattern(), StandardCharsets.UTF_8) + " in content");
   }
}

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	DEFAULT_LEFT_SIDE_PATTERN The default left side binary pattern of the literals.
static byte[]	DEFAULT_RIGHT_SIDE_PATTERN The default right side binary pattern of the literals.

Constructor Summary

Constructors

Constructor and Description
ReplaceVariableLiteralsInBinaryContent(byte[] content, java.util.Map<java.lang.String,java.lang.String> nameValueMap) Create a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	execute() Search and replace the variable literals in the binary content.
java.util.List<java.lang.String>	getFailedReplaceVariablesList() Get a list of literal variable names whose name was not found in the name/value map.
byte[]	getLeftSidePattern() Get the left side binary pattern of the literals.
int	getNumFailedReplaces() Get the number of failed replaces.
int	getNumSuccessfulReplaces() Get the number of successful replaces.
byte[]	getResultContent() Get the result content.
byte[]	getRightSidePattern() Get the right side binary pattern of the literals.
java.util.List<ReplaceVariableLiteralsSuccessListEntry>	getSuccessfulReplaceList() Get a list of all successful replaced variables, inclusive the replaced value and the number of replaces.
void	setLeftSidePattern(byte[] leftSidePattern) Set the left side binary pattern of the literals.
void	setRightSidePattern(byte[] rightSidePattern) Set the right side binary pattern of the literals.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LEFT_SIDE_PATTERN

public static final byte[] DEFAULT_LEFT_SIDE_PATTERN

The default left side binary pattern of the literals.

DEFAULT_RIGHT_SIDE_PATTERN

public static final byte[] DEFAULT_RIGHT_SIDE_PATTERN

The default right side binary pattern of the literals.

Constructor Detail

ReplaceVariableLiteralsInBinaryContent

public ReplaceVariableLiteralsInBinaryContent(byte[] content,
                                              java.util.Map<java.lang.String,java.lang.String> nameValueMap)

Create a new instance.

Parameters:

content - the binary content in which the variable literals are replaced.

nameValueMap - a map of key = variable name, value = variable value

Throws:

java.lang.IllegalArgumentException - if the nameValueMap contains a formal invalid variable name

See Also:

Utils.isFormalValidVariableName(java.lang.String)

Method Detail

setLeftSidePattern

public void setLeftSidePattern(byte[] leftSidePattern)

Set the left side binary pattern of the literals.

Parameters:

leftSidePattern - the left side binary pattern of the literals.

Throws:

java.lang.IllegalArgumentException - if the left side binary pattern has zero length

See Also:

DEFAULT_LEFT_SIDE_PATTERN

getLeftSidePattern

public byte[] getLeftSidePattern()

Get the left side binary pattern of the literals.

Returns:

the left side binary pattern of the literals

setRightSidePattern

public void setRightSidePattern(byte[] rightSidePattern)

Set the right side binary pattern of the literals.

Parameters:

rightSidePattern - the right side binary pattern of the literals.

Throws:

java.lang.IllegalArgumentException - if the right side pattern has zero length

See Also:

DEFAULT_RIGHT_SIDE_PATTERN

getRightSidePattern

public byte[] getRightSidePattern()

Get the right side binary pattern of the literals.

Returns:

the right side binary pattern of the literals

execute

public boolean execute()

Search and replace the variable literals in the binary content.
Note: In case if the variable name of a literal is not found in the name/value map then the corresponding part of the content remains unchanged.

Returns:

true if all variable literals have successfully replaced.

getResultContent

public byte[] getResultContent()

Get the result content.

Returns:

the result content

getNumSuccessfulReplaces

public int getNumSuccessfulReplaces()

Get the number of successful replaces.

Returns:

the number of successful replaces

getSuccessfulReplaceList

public java.util.List<ReplaceVariableLiteralsSuccessListEntry> getSuccessfulReplaceList()

Get a list of all successful replaced variables, inclusive the replaced value and the number of replaces.

Returns:

a list of all successful replaced variables, inclusive the replaced value and the number of replaces

getNumFailedReplaces

public int getNumFailedReplaces()

Get the number of failed replaces.

Returns:

the number of failed replaces

getFailedReplaceVariablesList

public java.util.List<java.lang.String> getFailedReplaceVariablesList()

Get a list of literal variable names whose name was not found in the name/value map.

Returns:

a list of literal variable names whose name was not found in the name/value map