From 5ca43d3dd3eeaad3ae98625ae4f6567057004f09 Mon Sep 17 00:00:00 2001 From: Mumfrey Date: Sat, 14 Feb 2015 00:10:23 +0000 Subject: [PATCH] Flesh out missing validator javadoc --- .../validation/IMixinValidator.java | 17 ++++++++++- .../validation/MixinValidator.java | 30 +++++++++++++++++++ .../validation/ParentValidator.java | 13 ++++++++ .../validation/TargetValidator.java | 13 ++++++++ 4 files changed, 72 insertions(+), 1 deletion(-) diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/validation/IMixinValidator.java b/src/ap/java/org/spongepowered/tools/obfuscation/validation/IMixinValidator.java index afe46934..62a7921b 100644 --- a/src/ap/java/org/spongepowered/tools/obfuscation/validation/IMixinValidator.java +++ b/src/ap/java/org/spongepowered/tools/obfuscation/validation/IMixinValidator.java @@ -29,8 +29,23 @@ import java.util.Collection; import javax.lang.model.element.AnnotationMirror; import javax.lang.model.element.TypeElement; +import org.spongepowered.tools.obfuscation.TypeHandle; + +/** + * A mixin validator module, basically just a way of making the various sanity + * checks modular + */ public interface IMixinValidator { - public abstract boolean validate(TypeElement mixin, AnnotationMirror annotation, Collection targets); + /** + * Validate all the things, return false to halt processing of further + * validators. Raise compiler errors/warnings directly. + * + * @param mixin Mixin being validated + * @param annotation Mixin annotation + * @param targets Mixin targets + * @return False to halt processing of further validators + */ + public abstract boolean validate(TypeElement mixin, AnnotationMirror annotation, Collection targets); } diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/validation/MixinValidator.java b/src/ap/java/org/spongepowered/tools/obfuscation/validation/MixinValidator.java index 4279e8c2..9819c919 100644 --- a/src/ap/java/org/spongepowered/tools/obfuscation/validation/MixinValidator.java +++ b/src/ap/java/org/spongepowered/tools/obfuscation/validation/MixinValidator.java @@ -29,22 +29,52 @@ import javax.lang.model.element.Element; import javax.tools.Diagnostic.Kind; +/** + * Base class for mixin validators + */ public abstract class MixinValidator implements IMixinValidator { + /** + * Processing environment for this validator, used for raising compiler + * errors and warnings + */ protected final ProcessingEnvironment processingEnv; + /** + * ctor + * + * @param processingEnv Processing environment + */ public MixinValidator(ProcessingEnvironment processingEnv) { this.processingEnv = processingEnv; } + /** + * Output a compiler note + * + * @param note Message + * @param element Element to attach the note to + */ protected final void note(String note, Element element) { this.processingEnv.getMessager().printMessage(Kind.NOTE, note, element); } + /** + * Output a compiler note + * + * @param warning Message + * @param element Element to attach the warning to + */ protected final void warning(String warning, Element element) { this.processingEnv.getMessager().printMessage(Kind.WARNING, warning, element); } + /** + * Output a compiler note + * + * @param error Message + * @param element Element to attach the error to + */ protected final void error(String error, Element element) { this.processingEnv.getMessager().printMessage(Kind.ERROR, error, element); } diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/validation/ParentValidator.java b/src/ap/java/org/spongepowered/tools/obfuscation/validation/ParentValidator.java index a0272171..db01678c 100644 --- a/src/ap/java/org/spongepowered/tools/obfuscation/validation/ParentValidator.java +++ b/src/ap/java/org/spongepowered/tools/obfuscation/validation/ParentValidator.java @@ -35,12 +35,25 @@ import javax.lang.model.element.TypeElement; import org.spongepowered.tools.obfuscation.TypeHandle; +/** + * Validator which checks that the mixin parent is sane + */ public class ParentValidator extends MixinValidator { + /** + * ctor + * + * @param processingEnv Processing environment + */ public ParentValidator(ProcessingEnvironment processingEnv) { super(processingEnv); } + /* (non-Javadoc) + * @see org.spongepowered.tools.obfuscation.validation.IMixinValidator + * #validate(javax.lang.model.element.TypeElement, + * javax.lang.model.element.AnnotationMirror, java.util.Collection) + */ @Override public boolean validate(TypeElement mixin, AnnotationMirror annotation, Collection targets) { if (mixin.getEnclosingElement().getKind() != ElementKind.PACKAGE && !mixin.getModifiers().contains(Modifier.STATIC)) { diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/validation/TargetValidator.java b/src/ap/java/org/spongepowered/tools/obfuscation/validation/TargetValidator.java index 34ddd95c..db4f82f0 100644 --- a/src/ap/java/org/spongepowered/tools/obfuscation/validation/TargetValidator.java +++ b/src/ap/java/org/spongepowered/tools/obfuscation/validation/TargetValidator.java @@ -34,12 +34,25 @@ import javax.lang.model.type.TypeMirror; import org.spongepowered.tools.obfuscation.TypeHandle; +/** + * Validator which checks that the mixin targets are sane + */ public class TargetValidator extends MixinValidator { + /** + * ctor + * + * @param processingEnv Processing environment + */ public TargetValidator(ProcessingEnvironment processingEnv) { super(processingEnv); } + /* (non-Javadoc) + * @see org.spongepowered.tools.obfuscation.validation.IMixinValidator + * #validate(javax.lang.model.element.TypeElement, + * javax.lang.model.element.AnnotationMirror, java.util.Collection) + */ @Override public boolean validate(TypeElement mixin, AnnotationMirror annotation, Collection targets) { TypeMirror superClass = mixin.getSuperclass();