org.aspectj/org.aspectj.matcher/src/main/java/org/aspectj/weaver/patterns/DeclareTypeErrorOrWarning.java

/* *******************************************************************
 * Copyright (c) 2010 Contributors
 * All rights reserved.
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Public License v 2.0
 * which accompanies this distribution and is available at
 * https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt
 *
 * Contributors:
 *     Andy Clement     initial implementation
 * ******************************************************************/

package org.aspectj.weaver.patterns;

import java.io.IOException;
import java.util.Map;

import org.aspectj.weaver.CompressingDataOutputStream;
import org.aspectj.weaver.ISourceContext;
import org.aspectj.weaver.VersionedDataInputStream;
import org.aspectj.weaver.World;

/**
 * For a declare error/warning that specified a type pattern rather than a pointcut.
 *
 * @author Andy Clement
 * @since 1.6.9
 */
public class DeclareTypeErrorOrWarning extends Declare {
	private boolean isError;
	private TypePattern typePattern;
	private String message;

	public DeclareTypeErrorOrWarning(boolean isError, TypePattern typePattern, String message) {
		this.isError = isError;
		this.typePattern = typePattern;
		this.message = message;
	}

	/**
	 * returns "declare warning: <typepattern>: <message>" or "declare error: <typepattern>: <message>"
	 */
	public String toString() {
		StringBuilder buf = new StringBuilder();
		buf.append("declare ");
		if (isError) {
			buf.append("error: ");
		} else {
			buf.append("warning: ");
		}
		buf.append(typePattern);
		buf.append(": ");
		buf.append("\"");
		buf.append(message);
		buf.append("\";");
		return buf.toString();
	}

	public boolean equals(Object other) {
		if (!(other instanceof DeclareTypeErrorOrWarning)) {
			return false;
		}
		DeclareTypeErrorOrWarning o = (DeclareTypeErrorOrWarning) other;
		return (o.isError == isError) && o.typePattern.equals(typePattern) && o.message.equals(message);
	}

	public int hashCode() {
		int result = isError ? 19 : 23;
		result = 37 * result + typePattern.hashCode();
		result = 37 * result + message.hashCode();
		return result;
	}

	public Object accept(PatternNodeVisitor visitor, Object data) {
		return visitor.visit(this, data);
	}

	public Object traverse(PatternNodeVisitor visitor, Object data) {
		Object ret = accept(visitor, data);
		if (this.typePattern != null)
			this.typePattern.traverse(visitor, ret);
		return ret;
	}

	public void write(CompressingDataOutputStream s) throws IOException {
		s.writeByte(Declare.TYPE_ERROR_OR_WARNING);
		s.writeBoolean(isError);
		typePattern.write(s);
		s.writeUTF(message);
		writeLocation(s);
	}

	public static Declare read(VersionedDataInputStream s, ISourceContext context) throws IOException {
		Declare ret = new DeclareTypeErrorOrWarning(s.readBoolean(), TypePattern.read(s, context), s.readUTF());
		ret.readLocation(context, s);
		return ret;
	}

	public boolean isError() {
		return isError;
	}

	public String getMessage() {
		return message;
	}

	public TypePattern getTypePattern() {
		return typePattern;
	}

	public void resolve(IScope scope) {
		typePattern.resolve(scope.getWorld());
	}

	public Declare parameterizeWith(Map typeVariableBindingMap, World w) {
		Declare ret = new DeclareTypeErrorOrWarning(isError, typePattern.parameterizeWith(typeVariableBindingMap, w), message);
		ret.copyLocationFrom(this);
		return ret;
	}

	public boolean isAdviceLike() {
		return false;
	}

	public String getNameSuffix() {
		return "teow";
	}

	/**
	 * returns "declare type warning" or "declare type error"
	 */
	public String getName() {
		StringBuilder buf = new StringBuilder();
		buf.append("declare type ");
		if (isError) {
			buf.append("error");
		} else {
			buf.append("warning");
		}
		return buf.toString();
	}
}