com.bld.commons.utils.json.annotations.CleanExcessSpaces Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bld-common-utils Show documentation

There is a newer version: 2.0.6

/**
 * @author Francesco Baldi
 * @mail [email protected]
 * @class bld.commons.json.annotations.MaxConsecutiveSpace.java
 */
package com.bld.commons.utils.json.annotations;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import com.bld.commons.utils.json.annotations.deserialize.CleanExcessSpacesDeserialize;
import com.bld.commons.utils.types.UpperLowerType;
import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/**
 * The Interface MaxConsecutiveSpace.
 */
@Retention(RUNTIME)
@Target({ FIELD, METHOD, PARAMETER })
@JacksonAnnotationsInside
@JsonDeserialize(using = CleanExcessSpacesDeserialize.class)
@JsonInclude(Include.NON_NULL)
public @interface CleanExcessSpaces {

	/**
	 * Removes the all space type.
	 *
	 * @return true, if successful
	 */
	public boolean removeAllSpaceType() default false;
	
	/**
	 * Consecutive.
	 *
	 * @return the int
	 */
	public int consecutive() default 1;
	
	/**
	 * Trim.
	 *
	 * @return true, if successful
	 */
	public boolean trim() default true;
	
	/**
	 * Removes the endline.
	 *
	 * @return true, if successful
	 */
	public boolean removeEndline() default false;
	
	
	/**
	 * Upper lower type.
	 *
	 * @return the upper lower type
	 */
	public UpperLowerType upperLowerType() default UpperLowerType.NONE;
	
	
	
	/**
	 * Removes the tab.
	 *
	 * @return true, if successful
	 */
	public boolean removeTab() default false;
	
}