Class ChangeArmorType

code/src/java/pcgen/cdom/processor/ChangeArmorType.java:38–195

ChangeArmorType is a Processor that alters Armor Types. If the type to be modified matches the source type of the ChangeArmorType object, then the result type is returned. Otherwise, the incoming type is not modified. NOTE: It is possible (albeit strange) to use ChangeArmorType as a "RemoveArmorTy

 * should expect that applyProcessor(String, Object) may return null.
 */
public class ChangeArmorType implements Processor<String>
{

	/**
	 * The source type for this ChangeArmorType. If the type to be modified
	 * matches the source type of the ChangeArmorType object, then this Processor
	 * will act on the incoming type.
	 */
	private final String source;

	/**
	 * The result type for this ChangeArmorType. If the Processor acts on the
	 * incoming type, it will return this type in place of the incoming type.
	 */
	private final String result;

	/**
	 * Constructs a new ChangeArmorType with the given source and result types.
	 * 
	 * @param sourceType
	 *            The source type for this ChangeArmorType, to be tested against
	 *            the types provided in applyProcessor
	 * @param resultType
	 *            The result type for this ChangeArmorType, to be returned from
	 *            applyProcessor if the Processor acts on the incoming type. May
	 *            be null to indicate this ChangeArmorType should remove the
	 *            source armor type
	 * @throws IllegalArgumentException
	 *             if the given source type is null
	 */
	public ChangeArmorType(String sourceType, String resultType)
	{
		Objects.requireNonNull(sourceType, "Source Type for ChangeArmorType cannot be null");
		Objects.requireNonNull(resultType, "Resulting Type for ChangeArmorType cannot be null");
		result = resultType;
		source = sourceType;
	}

	/**
	 * Applies this Processor to the given input armor type.
	 * 
	 * If the type to be modified matches the source type of the ChangeArmorType
	 * object, then the result type is returned. Otherwise, the incoming type is
	 * not modified (and the incoming type is returned).
	 * 
	 * Since ChangeArmorType is universal, the given context is ignored.
	 * 
	 * NOTE: It is possible (albeit strange) to use ChangeArmorType as a
	 * "RemoveArmorType", in that the result type can be null. Therefore, users
	 * should account for the possibility that this method may return null.
	 * 
	 * @param sourceType
	 *            The input armor type this Processor will act upon
	 * @param context
	 *            The context of this Processor, ignored by ChangeArmorType.
	 * @return The modified armor type, if the type to be modified matches the
	 *         source type of the ChangeArmorType object; otherwise the source
	 *         armor type