org.helenus.jackson.annotation.JsonPropertyMaximumValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helenus-commons Show documentation

JPA-like syntax for annotating POJO classes for persistence via Cassandra's Java driver - Common Utilities

There is a newer version: 3.0.4

/*
 * Copyright (C) 2015-2015 The Helenus Driver Project Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.helenus.jackson.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.fasterxml.jackson.annotation.JacksonAnnotation;

/**
 * The JsonPropertyMaximumValue annotation is used to indicate the
 * maximum value for the annotated number property.
 *
 * @copyright 2015-2015 The Helenus Driver Project Authors
 *
 * @author  The Helenus Driver Project Authors
 * @version 1 - Oct 29, 2015 - paouelle - Creation
 *
 * @since 1.0
 */
@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@JacksonAnnotation
public @interface JsonPropertyMaximumValue {
  /**
   * Defines the maximum value for the annotated property or its contained
   * values.
   * 
   * Note: Only specified one or none.
   *
   * @author paouelle
   *
   * @return the maximum value for the annotated property or its contained
   *         values
   */
  double[] value() default {};

  /**
   * Indicates whether or not the maximum value for the annotated property or
   * its contained values is exclusive.
   *
   * @author paouelle
   *
   * @return true if the maximum value is exclusive;
   *         false if it is inclusive (default)
   */
  boolean valueExclusive() default false;

  /**
   * Defines the maximum value for the annotated property contained keys.
   * 
   * Note: Only specified one or none.
   *
   * @author paouelle
   *
   * @return the maximum value for the annotated property contained keys
   */
  double[] key() default {};

  /**
   * Indicates whether or not the maximum value for the annotated property
   * contained keys is exclusive.
   *
   * @author paouelle
   *
   * @return true if the maximum value is exclusive;
   *         false if it is inclusive (default)
   */
  boolean keyExclusive() default false;
}