All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.juneau.dto.swagger.ParameterInfo Maven / Gradle / Ivy

Go to download

Apache Juneau UberJar

There is a newer version: 9.0.1
Show newest version
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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.apache.juneau.dto.swagger;

import static org.apache.juneau.internal.ArrayUtils.*;

import java.util.*;

import org.apache.juneau.*;
import org.apache.juneau.annotation.*;

/**
 * Describes a single operation parameter.
 *
 * 

 * A unique parameter is defined by a combination of a name and location.
 *
 * 

 * There are five possible parameter types.
 * 
    
 * 	
  • "path" - Used together with Path Templating, where the parameter value is actually part of the
 * 		operation's URL.
 * 		This does not include the host or base path of the API.
 * 		For example, in /items/{itemId}, the path parameter is itemId.
 * 	
  • "query" - Parameters that are appended to the URL.
 * 		For example, in /items?id=###, the query parameter is id.
 * 	
  • "header" - Custom headers that are expected as part of the request.
 * 	
  • "body" - The payload that's appended to the HTTP request.
 * 		Since there can only be one payload, there can only be one body parameter.
 * 		The name of the body parameter has no effect on the parameter itself and is used for documentation purposes
 * 		only.
 * 		Since Form parameters are also in the payload, body and form parameters cannot exist together for the same
 * 		operation.
 * 	
  • "formData" - Used to describe the payload of an HTTP request when either
 * 		application/x-www-form-urlencoded, multipart/form-data or both are used as the
 * 		content type of the request (in Swagger's definition, the consumes property of an operation).
 * 		This is the only parameter type that can be used to send files, thus supporting the file type.
 * 		Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the
 * 		same operation.
 * 		Form parameters have a different format based on the content-type used (for further details, consult
 * 		http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):
 * 		
      
 * 			
    • "application/x-www-form-urlencoded" - Similar to the format of Query parameters but as a
 * 				payload.
 * 				For example, foo=1&bar=swagger - both foo and bar are form
 * 				parameters.
 * 				This is normally used for simple parameters that are being transferred.
 * 			
    • "multipart/form-data" - each parameter takes a section in the payload with an internal header.
 * 				For example, for the header Content-Disposition: form-data; name="submit-name" the name of
 * 				the parameter is submit-name.
 * 				This type of form parameters is more commonly used for file transfers.
 * 		
    
 * 	
    • 
 * 

 *
 * 
Additional Information

 * 
 */
@Bean(properties="in,name,type,description,required,schema,format,allowEmptyValue,items,collectionFormat,default,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,enum,multipleOf")
public class ParameterInfo extends SwaggerElement {

	private static final String[] VALID_IN = {"query", "header", "path", "formData", "body"};
	private static final String[] VALID_TYPES = {"string", "number", "integer", "boolean", "array", "file"};
	private static final String[] VALID_COLLECTION_FORMATS = {"csv", "ssv", "tsv", "pipes", "multi"};

	private String name;
	private String in;
	private String description;
	private Boolean required;
	private SchemaInfo schema;
	private String type;
	private String format;
	private Boolean allowEmptyValue;
	private Items items;
	private String collectionFormat;
	private Object _default;
	private Number maximum;
	private Boolean exclusiveMaximum;
	private Number minimum;
	private Boolean exclusiveMinimum;
	private Integer maxLength;
	private Integer minLength;
	private String pattern;
	private Integer maxItems;
	private Integer minItems;
	private Boolean uniqueItems;
	private List _enum;
	private Number multipleOf;

	@Override /* SwaggerElement */
	protected ParameterInfo strict() {
		super.strict();
		return this;
	}

	/**
	 * Bean property getter:  name.
	 *
	 * 

	 * Required. The name of the parameter.
	 *
	 * 

	 * Parameter names are case sensitive.
	 * If in is "path", the name field MUST correspond to the associated path segment
	 * from the path field in the Paths Object.
	 * See Path Templating for further
	 * information.
	 * For all other cases, the name corresponds to the parameter name used based on the in property.
	 *
	 * @return The value of the name property on this bean, or null if it is not set.
	 */
	public String getName() {
		return name;
	}

	/**
	 * Bean property setter:  name.
	 *
	 * 

	 * Required. The name of the parameter.
	 *
	 * 

	 * Parameter names are case sensitive.
	 * If in is "path", the name field MUST correspond to the associated path segment
	 * from the path field in the Paths Object.
	 * See Path Templating for further
	 * information.
	 * For all other cases, the name corresponds to the parameter name used based on the in property.
	 *
	 * @param name The new value for the name property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setName(String name) {
		if (! "body".equals(in))
			this.name = name;
		return this;
	}

	/**
	 * Synonym for {@link #setName(String)}.
	 *
	 * @param name The new value for the name property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo name(String name) {
		return setName(name);
	}

	/**
	 * Bean property getter:  in.
	 *
	 * 

	 * Required. The location of the parameter.
	 *
	 * 

	 * Possible values are "query", "header", "path", "formData" or "body".
	 *
	 * @return The value of the in property on this bean, or null if it is not set.
	 */
	public String getIn() {
		return in;
	}

	/**
	 * Bean property setter:  in.
	 *
	 * 

	 * Required. The location of the parameter.
	 *
	 * 

	 * Possible values are "query", "header", "path", "formData" or "body".
	 *
	 * @param in The new value for the in property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setIn(String in) {
		if (isStrict() && ! contains(in, VALID_IN))
			throw new FormattedRuntimeException(
				"Invalid value passed in to setIn(String).  Value=''{0}'', valid values={1}",
				in, VALID_IN
			);
		this.in = in;
		if ("path".equals(in))
			required = true;
		return this;
	}

	/**
	 * Synonym for {@link #setIn(String)}.
	 *
	 * @param in The new value for the in property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo in(String in) {
		return setIn(in);
	}

	/**
	 * Bean property getter:  description.
	 *
	 * 

	 * A brief description of the parameter.
	 *
	 * 

	 * This could contain examples of use.
	 * GFM syntax can be used
	 * for rich text representation.
	 *
	 * @return
	 * 	The value of the description property on this bean, or null if it is not set.
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * Bean property setter:  description.
	 *
	 * 

	 * A brief description of the parameter.
	 *
	 * 

	 * This could contain examples of use.
	 * GFM syntax can be used
	 * for rich text representation.
	 *
	 * @param description The new value for the description property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setDescription(String description) {
		this.description = description;
		return this;
	}

	/**
	 * Synonym for {@link #setDescription(String)}.
	 *
	 * @param description The new value for the description property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo description(String description) {
		return setDescription(description);
	}

	/**
	 * Bean property getter:  required.
	 *
	 * 

	 * Determines whether this parameter is mandatory.
	 *
	 * 

	 * If the parameter is in "path", this property is required and its value MUST be
	 * true.
	 * Otherwise, the property MAY be included and its default value is false.
	 *
	 * @return The value of the required property on this bean, or null if it is not set.
	 */
	public Boolean getRequired() {
		return required;
	}

	/**
	 * Bean property setter:  required.
	 *
	 * 

	 * Determines whether this parameter is mandatory.
	 *
	 * 

	 * If the parameter is in "path", this property is required and its value MUST be
	 * true.
	 * Otherwise, the property MAY be included and its default value is false.
	 *
	 * @param required The new value for the required property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setRequired(Boolean required) {
		this.required = required;
		return this;
	}

	/**
	 * Synonym for {@link #setRequired(Boolean)}.
	 *
	 * @param required The new value for the required property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo required(Boolean required) {
		return setRequired(required);
	}

	/**
	 * Bean property getter:  schema.
	 *
	 * 

	 * Required. The schema defining the type used for the body parameter.
	 *
	 * @return The value of the schema property on this bean, or null if it is not set.
	 */
	public SchemaInfo getSchema() {
		return schema;
	}

	/**
	 * Bean property setter:  schema.
	 *
	 * 

	 * Required. The schema defining the type used for the body parameter.
	 *
	 * @param schema The new value for the schema property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setSchema(SchemaInfo schema) {
		this.schema = schema;
		return this;
	}

	/**
	 * Synonym for {@link #setSchema(SchemaInfo)}.
	 *
	 * @param schema The new value for the schema property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo schema(SchemaInfo schema) {
		return setSchema(schema);
	}

	/**
	 * Bean property getter:  type.
	 *
	 * 

	 * Required. The type of the parameter.
	 *
	 * 

	 * Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
	 * The value MUST be one of "string", "number", "integer", "boolean",
	 * "array" or "file".
	 * If type is "file", the consumes MUST be either "multipart/form-data",
	 * "application/x-www-form-urlencoded" or both and the parameter MUST be in
	 * "formData".
	 *
	 * @return The value of the type property on this bean, or null if it is not set.
	 */
	public String getType() {
		return type;
	}

	/**
	 * Bean property setter:  type.
	 *
	 * 

	 * Required. The type of the parameter.
	 *
	 * 

	 * Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
	 * The value MUST be one of "string", "number", "integer", "boolean",
	 * "array" or "file".
	 * If type is "file", the consumes MUST be either "multipart/form-data",
	 * "application/x-www-form-urlencoded" or both and the parameter MUST be in
	 * "formData".
	 *
	 * @param type The new value for the type property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setType(String type) {
		if (isStrict() && ! contains(type, VALID_TYPES))
			throw new FormattedRuntimeException(
				"Invalid value passed in to setType(String).  Value=''{0}'', valid values={1}",
				type, VALID_TYPES
			);
		this.type = type;
		return this;
	}

	/**
	 * Synonym for {@link #setType(String)}.
	 *
	 * @param type The new value for the type property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo type(String type) {
		return setType(type);
	}

	/**
	 * Bean property getter:  format.
	 *
	 * 

	 * The extending format for the previously mentioned type.
	 *
	 * 

	 * See Data Type Formats for further
	 * details.
	 *
	 * @return The value of the format property on this bean, or null if it is not set.
	 */
	public String getFormat() {
		return format;
	}

	/**
	 * Bean property setter:  format.
	 *
	 * 

	 * The extending format for the previously mentioned type.
	 *
	 * 

	 * See Data Type Formats for further
	 * details.
	 *
	 * @param format The new value for the format property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setFormat(String format) {
		this.format = format;
		return this;
	}

	/**
	 * Synonym for {@link #setFormat(String)}.
	 *
	 * @param format The new value for the format property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo format(String format) {
		return setFormat(format);
	}

	/**
	 * Bean property getter:  allowEmptyValue.
	 *
	 * 

	 * Sets the ability to pass empty-valued parameters.
	 *
	 * 

	 * This is valid only for either query or formData parameters and allows you to send a
	 * parameter with a name only or an empty value.
	 * Default value is false.
	 *
	 * @return The value of the allowEmptyValue property on this bean, or null if it is
	 * not set.
	 */
	public Boolean getAllowEmptyValue() {
		return allowEmptyValue;
	}

	/**
	 * Bean property setter:  allowEmptyValue.
	 *
	 * 

	 * Sets the ability to pass empty-valued parameters.
	 *
	 * 

	 * This is valid only for either query or formData parameters and allows you to send a
	 * parameter with a name only or an empty value.
	 * Default value is false.
	 *
	 * @param allowEmptyValue The new value for the allowEmptyValue property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setAllowEmptyValue(Boolean allowEmptyValue) {
		this.allowEmptyValue = allowEmptyValue;
		return this;
	}

	/**
	 * Synonym for {@link #setAllowEmptyValue(Boolean)}.
	 *
	 * @param allowEmptyValue The new value for the allowEmptyValue property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo allowEmptyValue(Boolean allowEmptyValue) {
		return setAllowEmptyValue(allowEmptyValue);
	}

	/**
	 * Bean property getter:  items.
	 *
	 * 

	 * Required if type is "array".
	 *
	 * 

	 * Describes the type of items in the array.
	 *
	 * @return The value of the items property on this bean, or null if it is not set.
	 */
	public Items getItems() {
		return items;
	}

	/**
	 * Bean property setter:  items.
	 *
	 * 

	 * Required if type is "array".
	 *
	 * 

	 * Describes the type of items in the array.
	 *
	 * @param items The new value for the items property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setItems(Items items) {
		this.items = items;
		return this;
	}

	/**
	 * Synonym for {@link #setItems(Items)}.
	 *
	 * @param items The new value for the items property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo items(Items items) {
		return setItems(items);
	}

	/**
	 * Bean property getter:  collectionFormat.
	 *
	 * 

	 * Determines the format of the array if type array is used.
	 *
	 * 

	 * Possible values are:
	 * 
    
	 * 	
  • csv - comma separated values foo,bar.
	 * 	
  • ssv - space separated values foo bar.
	 * 	
  • tsv - tab separated values foo\tbar.
	 * 	
  • pipes - pipe separated values foo|bar.
	 * 	
  • multi - corresponds to multiple parameter instances instead of multiple values for a single
	 * 		instance foo=bar&foo=baz.
	 * 		This is valid only for parameters in "query" or "formData".
	 * 

	 *
	 * 

	 * Default value is csv.
	 *
	 * @return
	 * 	The value of the collectionFormat property on this bean, or null if it is
	 * 	not set.
	 */
	public String getCollectionFormat() {
		return collectionFormat;
	}

	/**
	 * Bean property setter:  collectionFormat.
	 *
	 * 

	 * Determines the format of the array if type array is used.
	 *
	 * 

	 * Possible values are:
	 * 
    
	 * 	
  • csv - comma separated values foo,bar.
	 * 	
  • ssv - space separated values foo bar.
	 * 	
  • tsv - tab separated values foo\tbar.
	 * 	
  • pipes - pipe separated values foo|bar.
	 * 	
  • multi - corresponds to multiple parameter instances instead of multiple values for a single
	 * 		instance foo=bar&foo=baz.
	 * 		This is valid only for parameters in "query" or "formData".
	 * 

	 *
	 * 

	 * Default value is csv.
	 *
	 * @param collectionFormat The new value for the collectionFormat property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setCollectionFormat(String collectionFormat) {
		if (isStrict() && ! contains(collectionFormat, VALID_COLLECTION_FORMATS))
			throw new FormattedRuntimeException(
				"Invalid value passed in to setCollectionFormat(String).  Value=''{0}'', valid values={1}",
				collectionFormat, VALID_COLLECTION_FORMATS
			);
		this.collectionFormat = collectionFormat;
		return this;
	}

	/**
	 * Synonym for {@link #setCollectionFormat(String)}.
	 *
	 * @param collectionFormat The new value for the collectionFormat property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo collectionFormat(String collectionFormat) {
		return setCollectionFormat(collectionFormat);
	}

	/**
	 * Bean property getter:  default.
	 *
	 * 

	 * Declares the value of the parameter that the server will use if none is provided, for example a "count"
	 * to control the number of results per page might default to 100 if not supplied by the client in the request.
	 * (Note: "default" has no meaning for required parameters.)
	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor101.
	 * Unlike JSON Schema this value MUST conform to the defined type for this parameter.
	 *
	 * @return The value of the default property on this bean, or null if it is not set.
	 */
	public Object getDefault() {
		return _default;
	}

	/**
	 * Bean property setter:  default.
	 *
	 * 

	 * Declares the value of the parameter that the server will use if none is provided, for example a "count"
	 * to control the number of results per page might default to 100 if not supplied by the client in the request.
	 * (Note: "default" has no meaning for required parameters.)
	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor101.
	 * Unlike JSON Schema this value MUST conform to the defined type for this parameter.
	 *
	 * @param _default The new value for the default property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setDefault(Object _default) {
		this._default = _default;
		return this;
	}

	/**
	 * Synonym for {@link #setDefault(Object)}.
	 *
	 * @param _default The new value for the default property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo _default(Object _default) {
		return setDefault(_default);
	}

	/**
	 * Bean property getter:  maximum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor17.
	 *
	 * @return The value of the maximum property on this bean, or null if it is not set.
	 */
	public Number getMaximum() {
		return maximum;
	}

	/**
	 * Bean property setter:  maximum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor17.
	 *
	 * @param maximum The new value for the maximum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setMaximum(Number maximum) {
		this.maximum = maximum;
		return this;
	}

	/**
	 * Synonym for {@link #setMaximum(Number)}.
	 *
	 * @param maximum The new value for the maximum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo maximum(Number maximum) {
		return setMaximum(maximum);
	}

	/**
	 * Bean property getter:  exclusiveMaximum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor17.
	 *
	 * @return The value of the exclusiveMaximum property on this bean, or null
	 * if it is not set.
	 */
	public Boolean getExclusiveMaximum() {
		return exclusiveMaximum;
	}

	/**
	 * Bean property setter:  exclusiveMaximum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor17.
	 *
	 * @param exclusiveMaximum The new value for the exclusiveMaximum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setExclusiveMaximum(Boolean exclusiveMaximum) {
		this.exclusiveMaximum = exclusiveMaximum;
		return this;
	}

	/**
	 * Synonym for {@link #setExclusiveMaximum(Boolean)}.
	 *
	 * @param exclusiveMaximum The new value for the exclusiveMaximum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo exclusiveMaximum(Boolean exclusiveMaximum) {
		return setExclusiveMaximum(exclusiveMaximum);
	}

	/**
	 * Bean property getter:  minimum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor21.
	 *
	 * @return The value of the minimum property on this bean, or null if it is not set.
	 */
	public Number getMinimum() {
		return minimum;
	}

	/**
	 * Bean property setter:  minimum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor21.
	 *
	 * @param minimum The new value for the minimum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setMinimum(Number minimum) {
		this.minimum = minimum;
		return this;
	}

	/**
	 * Synonym for {@link #setMinimum(Number)}.
	 *
	 * @param minimum The new value for the minimum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo minimum(Number minimum) {
		return setMinimum(minimum);
	}

	/**
	 * Bean property getter:  exclusiveMinimum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor21.
	 *
	 * @return The value of the exclusiveMinimum property on this bean, or null if it is
	 * not set.
	 */
	public Boolean getExclusiveMinimum() {
		return exclusiveMinimum;
	}

	/**
	 * Bean property setter:  exclusiveMinimum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor21.
	 *
	 * @param exclusiveMinimum The new value for the exclusiveMinimum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setExclusiveMinimum(Boolean exclusiveMinimum) {
		this.exclusiveMinimum = exclusiveMinimum;
		return this;
	}

	/**
	 * Synonym for {@link #setExclusiveMinimum(Boolean)}.
	 *
	 * @param exclusiveMinimum The new value for the exclusiveMinimum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo exclusiveMinimum(Boolean exclusiveMinimum) {
		return setExclusiveMinimum(exclusiveMinimum);
	}

	/**
	 * Bean property getter:  maxLength.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor26.
	 *
	 * @return The value of the maxLength property on this bean, or null if it is not set.
	 */
	public Integer getMaxLength() {
		return maxLength;
	}

	/**
	 * Bean property setter:  maxLength.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor26.
	 *
	 * @param maxLength The new value for the maxLength property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setMaxLength(Integer maxLength) {
		this.maxLength = maxLength;
		return this;
	}

	/**
	 * Synonym for {@link #setMaxLength(Integer)}.
	 *
	 * @param maxLength The new value for the maxLength property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo maxLength(Integer maxLength) {
		return setMaxLength(maxLength);
	}

	/**
	 * Bean property getter:  minLength.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor29.
	 *
	 * @return The value of the minLength property on this bean, or null if it is not set.
	 */
	public Integer getMinLength() {
		return minLength;
	}

	/**
	 * Bean property setter:  minLength.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor29.
	 *
	 * @param minLength The new value for the minLength property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setMinLength(Integer minLength) {
		this.minLength = minLength;
		return this;
	}

	/**
	 * Synonym for {@link #setMinLength(Integer)}.
	 *
	 * @param minLength The new value for the minLength property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo minLength(Integer minLength) {
		return setMinLength(minLength);
	}

	/**
	 * Bean property getter:  pattern.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor33.
	 *
	 * @return The value of the pattern property on this bean, or null if it is not set.
	 */
	public String getPattern() {
		return pattern;
	}

	/**
	 * Bean property setter:  pattern.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor33.
	 *
	 * @param pattern The new value for the pattern property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setPattern(String pattern) {
		this.pattern = pattern;
		return this;
	}

	/**
	 * Synonym for {@link #setPattern(String)}.
	 *
	 * @param pattern The new value for the pattern property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo pattern(String pattern) {
		return setPattern(pattern);
	}

	/**
	 * Bean property getter:  maxItems.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor42.
	 *
	 * @return The value of the maxItems property on this bean, or null if it is not set.
	 */
	public Integer getMaxItems() {
		return maxItems;
	}

	/**
	 * Bean property setter:  maxItems.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor42.
	 *
	 * @param maxItems The new value for the maxItems property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setMaxItems(Integer maxItems) {
		this.maxItems = maxItems;
		return this;
	}

	/**
	 * Synonym for {@link #setMaxItems(Integer)}.
	 *
	 * @param maxItems The new value for the maxItems property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo maxItems(Integer maxItems) {
		return setMaxItems(maxItems);
	}

	/**
	 * Bean property getter:  minItems.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor45.
	 *
	 * @return The value of the minItems property on this bean, or null if it is not set.
	 */
	public Integer getMinItems() {
		return minItems;
	}

	/**
	 * Bean property setter:  minItems.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor45.
	 *
	 * @param minItems The new value for the minItems property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setMinItems(Integer minItems) {
		this.minItems = minItems;
		return this;
	}

	/**
	 * Synonym for {@link #setMinItems(Integer)}.
	 *
	 * @param minItems The new value for the minItems property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo minItems(Integer minItems) {
		return setMinItems(minItems);
	}

	/**
	 * Bean property getter:  uniqueItems.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor49.
	 *
	 * @return The value of the uniqueItems property on this bean, or null if it is not
	 * set.
	 */
	public Boolean getUniqueItems() {
		return uniqueItems;
	}

	/**
	 * Bean property setter:  uniqueItems.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor49.
	 *
	 * @param uniqueItems The new value for the uniqueItems property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setUniqueItems(Boolean uniqueItems) {
		this.uniqueItems = uniqueItems;
		return this;
	}

	/**
	 * Synonym for {@link #setUniqueItems(Boolean)}.
	 *
	 * @param uniqueItems The new value for the uniqueItems property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo uniqueItems(Boolean uniqueItems) {
		return setUniqueItems(uniqueItems);
	}

	/**
	 * Bean property getter:  enum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor76.
	 *
	 * @return The value of the enum property on this bean, or null if it is not set.
	 */
	public List getEnum() {
		return _enum;
	}

	/**
	 * Bean property setter:  enum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor76.
	 *
	 * @param _enum The new value for the enum property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setEnum(List _enum) {
		this._enum = _enum;
		return this;
	}

	/**
	 * Bean property adder:  enum.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor76.
	 *
	 * @param _enum
	 * 	The new values to add to the enum property on this bean.
	 * 	These can either be individual objects or {@link Collection Collections} of objects.
	 * @return This object (for method chaining).
	 */
	@SuppressWarnings("unchecked")
	public ParameterInfo addEnum(Object..._enum) {
		for (Object o  : _enum) {
			if (o != null) {
				if (o instanceof Collection)
					addEnum((Collection)o);
				else {
					if (this._enum == null)
						this._enum = new LinkedList();
					this._enum.add(o);
				}
			}
		}
		return this;
	}

	/**
	 * Synonym for {@link #addEnum(Object...)}.
	 *
	 * @param _enum
	 * 	The new values to add to the enum property on this bean.
	 * 	These can either be individual objects or {@link Collection Collections} of objects.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo _enum(Object..._enum) {
		return addEnum(_enum);
	}

	/**
	 * Bean property getter:  multipleOf.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor14.
	 *
	 * @return The value of the multipleOf property on this bean, or null if it is not set.
	 */
	public Number getMultipleOf() {
		return multipleOf;
	}

	/**
	 * Bean property setter:  multipleOf.
	 *
	 * 

	 * See 
	 * http://json-schema.org/latest/json-schema-validation.html#anchor14.
	 *
	 * @param multipleOf The new value for the multipleOf property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo setMultipleOf(Number multipleOf) {
		this.multipleOf = multipleOf;
		return this;
	}

	/**
	 * Synonym for {@link #setMultipleOf(Number)}.
	 *
	 * @param multipleOf The new value for the multipleOf property on this bean.
	 * @return This object (for method chaining).
	 */
	public ParameterInfo multipleOf(Number multipleOf) {
		return setMultipleOf(multipleOf);
	}
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy