io.github.astrapi69.crypt.data.obfuscation.rule.ObfuscationRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crypt-data Show documentation
Utility project that provides data beans, writers and readers for encryption and decryption
There is a newer version: 10
/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.astrapi69.crypt.data.obfuscation.rule;

import java.io.Serializable;
import java.util.Objects;

/**
 * The type Obfuscation rule.
 *
 * @param 
 *            the type parameter
 * @param 
 *            the type parameter
 */
public class ObfuscationRule implements Serializable
{
	/** The Constant serialVersionUID. */
	private static final long serialVersionUID = 1L;
	/** The character to be obfuscated */
	private C character;
	/** The character(s) that will replace the original character */
	private RW replaceWith;

	/**
	 * Instantiates a new Obfuscation rule
	 */
	public ObfuscationRule()
	{
	}

	/**
	 * Instantiates a new Obfuscation rule
	 *
	 * @param character
	 *            the character to be obfuscated
	 * @param replaceWith
	 *            the replacement character(s)
	 */
	public ObfuscationRule(C character, RW replaceWith)
	{
		Objects.requireNonNull(character);
		Objects.requireNonNull(replaceWith);
		this.character = character;
		this.replaceWith = replaceWith;
	}

	/**
	 * Builder obfuscation rule builder
	 *
	 * @param 
	 *            the type parameter for the character to be obfuscated
	 * @param 
	 *            the type parameter for the replacement character(s)
	 * @return the obfuscation rule builder
	 */
	public static  ObfuscationRuleBuilder builder()
	{
		return new ObfuscationRuleBuilder<>();
	}

	@Override
	public boolean equals(final Object o)
	{
		if (o == this)
			return true;
		if (!(o instanceof ObfuscationRule))
			return false;
		final ObfuscationRule other = (ObfuscationRule)o;
		final Object this$character = this.getCharacter();
		final Object other$character = other.getCharacter();
		if (this$character == null
			? other$character != null
			: !this$character.equals(other$character))
			return false;
		final Object this$replaceWith = this.getReplaceWith();
		final Object other$replaceWith = other.getReplaceWith();
		return this$replaceWith == null
			? other$replaceWith == null
			: this$replaceWith.equals(other$replaceWith);
	}

	/**
	 * Gets character
	 *
	 * @return the character to be obfuscated
	 */
	public C getCharacter()
	{
		return this.character;
	}

	/**
	 * Sets character
	 *
	 * @param character
	 *            the character to be obfuscated
	 */
	public void setCharacter(C character)
	{
		Objects.requireNonNull(character);
		this.character = character;
	}

	/**
	 * Gets replace with
	 *
	 * @return the replacement character(s)
	 */
	public RW getReplaceWith()
	{
		return this.replaceWith;
	}

	/**
	 * Sets replace with
	 *
	 * @param replaceWith
	 *            the replacement character(s)
	 */
	public void setReplaceWith(RW replaceWith)
	{
		Objects.requireNonNull(replaceWith);
		this.replaceWith = replaceWith;
	}

	@Override
	public int hashCode()
	{
		final int PRIME = 59;
		int result = 1;
		final Object $character = this.getCharacter();
		result = result * PRIME + ($character == null ? 43 : $character.hashCode());
		final Object $replaceWith = this.getReplaceWith();
		result = result * PRIME + ($replaceWith == null ? 43 : $replaceWith.hashCode());
		return result;
	}

	/**
	 * To builder obfuscation rule builder
	 *
	 * @return the obfuscation rule builder
	 */
	public ObfuscationRuleBuilder toBuilder()
	{
		return new ObfuscationRuleBuilder().character(this.character)
			.replaceWith(this.replaceWith);
	}

	@Override
	public String toString()
	{
		return "ObfuscationRule(character=" + this.getCharacter() + ", replaceWith="
			+ this.getReplaceWith() + ")";
	}

	/**
	 * The type Obfuscation rule builder
	 *
	 * @param 
	 *            the type parameter for the character to be obfuscated
	 * @param 
	 *            the type parameter for the replacement character(s)
	 */
	public static class ObfuscationRuleBuilder
	{
		private C character;
		private RW replaceWith;

		/**
		 * Instantiates a new Obfuscation rule builder
		 */
		ObfuscationRuleBuilder()
		{
		}

		/**
		 * Build obfuscation rule
		 *
		 * @return the obfuscation rule
		 */
		public ObfuscationRule build()
		{
			return new ObfuscationRule<>(character, replaceWith);
		}

		/**
		 * Character obfuscation rule builder
		 *
		 * @param character
		 *            the character to be obfuscated
		 * @return the obfuscation rule builder
		 */
		public ObfuscationRuleBuilder character(C character)
		{
			Objects.requireNonNull(character);
			this.character = character;
			return this;
		}

		/**
		 * Replace with obfuscation rule builder
		 *
		 * @param replaceWith
		 *            the replacement character(s)
		 * @return the obfuscation rule builder
		 */
		public ObfuscationRuleBuilder replaceWith(RW replaceWith)
		{
			Objects.requireNonNull(replaceWith);
			this.replaceWith = replaceWith;
			return this;
		}

		@Override
		public String toString()
		{
			return "ObfuscationRule.ObfuscationRuleBuilder(character=" + this.character
				+ ", replaceWith=" + this.replaceWith + ")";
		}
	}
}