Package com.blamejared.crafttweaker.impl.preprocessor

Class ReplacePreprocessor

java.lang.Object

com.blamejared.crafttweaker.impl.preprocessor.ReplacePreprocessor

All Implemented Interfaces:

IPreprocessor, Comparator<IScriptFile>

@ZenRegister
@Preprocessor
public final class ReplacePreprocessor
extends Object
implements IPreprocessor

#replace toReplace replaceWith

Nested Class Summary

Nested classes/interfaces inherited from interface com.blamejared.crafttweaker.api.zencode.IPreprocessor

IPreprocessor.Match

Field Summary

Fields inherited from interface com.blamejared.crafttweaker.api.zencode.IPreprocessor

PREPROCESSOR_PATTERN

Constructor Summary

Constructors

Constructor	Description
ReplacePreprocessor()

Method Summary

Modifier and Type	Method	Description
boolean	apply(IScriptFile file, List<String> preprocessedContents, IMutableScriptRunInfo runInfo, List<IPreprocessor.Match> matches)	Applies the preprocessor to the IScriptFile and the IMutableScriptRunInfo.
String	defaultValue()	Gets the default value of a preprocessor.
String	name()	Gets the name of the preprocessor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface com.blamejared.crafttweaker.api.zencode.IPreprocessor

compare, preprocessorEndMarker, priority

Constructor Details

ReplacePreprocessor

public ReplacePreprocessor()

Method Details

name

public String name()

Description copied from interface: IPreprocessor

Gets the name of the preprocessor.

It is illegal for a preprocessor name to contain spaces. It is also customary, although not required, for the preprocessor name to be all lowercase.

It is not allowed to specify the pound symbol as part of the name.

Specified by:

name in interface IPreprocessor

Returns:

The name of the preprocessor.

defaultValue

@Nullable
public String defaultValue()

Description copied from interface: IPreprocessor

Gets the default value of a preprocessor.

null is allowed and means that no default value is provided.

Specified by:

defaultValue in interface IPreprocessor

Returns:

The default value of the preprocessor.

apply

public boolean apply(IScriptFile file,
 List<String> preprocessedContents,
 IMutableScriptRunInfo runInfo,
 List<IPreprocessor.Match> matches)

Description copied from interface: IPreprocessor

Applies the preprocessor to the IScriptFile and the IMutableScriptRunInfo.

Each preprocessor for which at least one match has been identified or that defines a non-null default value will be called. This method will regardless be called at most once for every file in a single script run.

It is possible for a preprocessor to modify the file contents by acting directly on the preprocessedContents list, whereas the run information can be altered through the runInfo parameter. All other information is read-only.

A preprocessor can also prevent loading of the file and further pre-processing by returning false in this method.

Specified by:

apply in interface IPreprocessor

Parameters:

file - The file on which the preprocessor is being invoked on.

preprocessedContents - The contents of the file, as preprocessed by other preprocessors. If this preprocessor wants to modify the file contents, it is allowed to act directly on this list.

runInfo - A IMutableScriptRunInfo representing information related to the run and allowing modification if desired.

matches - A read-only list containing all preprocessor matches in the current file. The matches are guaranteed to be ordered from top to bottom.

Returns:

Whether the file is still eligible for loading (true) or if it should be discarded (false).