ca.uwaterloo.asw4j.internal.InstructionClassUtility Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asw4j Show documentation

asw4j(Auto Spread Work for Java) is a Java library aiming to take advantage of multi-core processors and remove the difficulty of the concurrent programming.

The newest version!

package ca.uwaterloo.asw4j.internal;

import java.lang.reflect.Type;

import ca.uwaterloo.asw4j.Instruction;
import ca.uwaterloo.asw4j.meta.DependOn;
import ca.uwaterloo.asw4j.meta.ProduceData;
import ca.uwaterloo.asw4j.meta.RequireData;
import ca.uwaterloo.asw4j.meta.Singleton;
import ca.uwaterloo.asw4j.reflection.TypeUtility;

/**
 * An utility class which provides useful functions to extract meta data from
 * {@link Instruction} classes.
 * 
 * @author Desmond Lin
 * @since 1.0.0
 */
public class InstructionClassUtility {

	public static final void checkPreconditionOfRequireDatas(String[] names,
			Type[] types) {

		if (types == null || types.length == 0) {
			throw new IllegalArgumentException();
		} else if (names == null || names.length == 0) {
			if (types.length != 1) {
				throw new IllegalArgumentException();
			}
		} else if (names.length != types.length) {
			throw new IllegalArgumentException();
		}
	}

	public static boolean getInstructionAsyncSupport(
			Class> instructionClass) {

		DependOn dependOnAnnotation = instructionClass
				.getAnnotation(DependOn.class);

		if (dependOnAnnotation != null) {
			return dependOnAnnotation.async();
		}

		return true;
	}

	public static Class>[] getInstructionDependencies(
			Class> instructionClass) {

		DependOn dependOnAnnotation = instructionClass
				.getAnnotation(DependOn.class);

		if (dependOnAnnotation != null) {
			Class>[] depends = dependOnAnnotation
					.instructions();
			if (depends != null) {
				return depends;
			}
		}

		return null;
	}

	public static final String getInstructionProduceDataName(
			Class> instructionClass) {

		ProduceData produceDataAnnotation = instructionClass
				.getAnnotation(ProduceData.class);
		if (produceDataAnnotation != null) {
			return produceDataAnnotation.name();
		}

		return null;
	}

	public static final Type getInstructionProduceDataType(
			Class> instructionClass) {
		return TypeUtility.getSuperclassTypeParameter(instructionClass)[1];
	}

	public static final String[] getInstructionRequireDataNames(
			Class> instructionClass) {

		RequireData requireDataAnnotation = instructionClass
				.getAnnotation(RequireData.class);

		if (requireDataAnnotation != null) {
			return requireDataAnnotation.names();
		}

		return null;
	}

	public static final Type[] getInstructionRequireDataTypes(
			Class> instructionClass) {

		RequireData requireDataAnnotation = instructionClass
				.getAnnotation(RequireData.class);

		if (requireDataAnnotation != null) {
			return requireDataAnnotation.types();
		}

		return new Type[] { TypeUtility
				.getSuperclassTypeParameter(instructionClass)[0] };
	}

	public static boolean getInstructionSingletonSupport(
			Class> instructionClass) {

		Singleton singletonAnnotation = instructionClass
				.getAnnotation(Singleton.class);
		if (singletonAnnotation != null) {
			return true;
		}

		return false;
	}
}