Interface ITMPTagValidator

Namespace

TMPEffects.Tags

Assembly

TMPEffects.dll

Tag validation interface.

public interface ITMPTagValidator

Methods

ValidateOpenTag(TagInfo, out TMPEffectTag, out int)

Validate a given ParsingUtility.TagInfo. MUST be of type Open.

bool ValidateOpenTag(ParsingUtility.TagInfo tagInfo, out TMPEffectTag data, out int endIndex)

Parameters

tagInfo ParsingUtility.TagInfo

Information about the tag.

data TMPEffectTag

Assuming the tag is validated, this will be set to the created TMPEffectTag; otherwise it will be null.

endIndex int

Assuming the tag is validated, this will be set to the endIndex of the tag. TODO this arguably exceeds ITMPTagValidators responsibilities

Returns

bool

true if the tag is successfully validated; false otherwise.

Exceptions

ArgumentException

ValidateTag(TMPEffectTag)

Validate a given TMPEffectTag.

bool ValidateTag(TMPEffectTag tag)

Parameters

tag TMPEffectTag

Information about the tag.

Returns

bool

true if the tag is successfully validated; false otherwise.

ValidateTag(TagInfo)

Validate a given ParsingUtility.TagInfo.

bool ValidateTag(ParsingUtility.TagInfo tagInfo)

Parameters

tagInfo ParsingUtility.TagInfo

Information about the tag.

Returns

bool

true if the tag is successfully validated; false otherwise.