All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.apache.juneau.dto.openapi3.ServerVariable Maven / Gradle / Ivy

    // ***************************************************************************************************************************
// * 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.openapi3;

import static org.apache.juneau.common.internal.StringUtils.*;
import static org.apache.juneau.internal.CollectionUtils.*;
import static org.apache.juneau.internal.ConverterUtils.*;

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

import java.util.Collection;
import java.util.List;
import java.util.Set;

/**
 * TODO
 */
@Bean(properties="enum,default,description,*")
@FluentSetters
public class ServerVariable extends OpenApiElement {

	private List _enum;
	private String _default;
	private String description;

	/**
	 * Default constructor.
	 */
	public ServerVariable() {}

	/**
	 * Copy constructor.
	 *
	 * @param copyFrom The object to copy.
	 */
	public ServerVariable(ServerVariable copyFrom) {
		super(copyFrom);

		this._enum = copyOf(copyFrom._enum);
		this._default = copyFrom._default;
		this.description = copyFrom.description;
	}

	/**
	 * Make a deep copy of this object.
	 * @return A deep copy of this object.
	 */
	public ServerVariable copy() {
		return new ServerVariable(this);
	}

	@Override /* OpenApiElement */
	protected ServerVariable strict() {
		super.strict();
		return this;
	}

	/**
	 * Bean property getter:  enum.
	 *
	 * @return The property value, or null if it is not set.
	 */
	public List getEnum() {
		return _enum;
	}

	/**
	 * Bean property setter:  enum.
	 *
	 * @param value
	 * 	The new value for this property.
	 * 	
    Can be null to unset the property.
	 * @return This object
	 */
	public ServerVariable setEnum(Collection value) {
		_enum = listFrom(value);
		return this;
	}

	/**
	 * Adds one or more values to the enum property.
	 *
	 * @param values
	 * 	The values to add to this property.
	 * 	
    Valid types:
	 * 	
      
	 * 		
    • Object
	 * 		
    • Collection<Object>
	 * 		
    • String - JSON array representation of Collection<Object>
	 * 			
      Example:
      
	 * 			
      
	 * 	_enum("['foo','bar']");
	 * 			
      
	 * 		
    • String - Individual values
	 * 			
      Example:
      
	 * 			
      
	 * 	_enum("foo", "bar");
	 * 			
      
	 * 	
    
	 * 	
    Ignored if null.
	 * @return This object
	 */
	public ServerVariable addEnum(Object...values) {
		_enum = listBuilder(_enum).sparse().addAny(values).build();
		return this;
	}

	/**
	 * Bean property getter:  default.
	 *
	 * 
    
	 * Declares the value of the item that the server will use if none is provided.
	 *
	 * 
    Notes:
    
	 * 
      
	 * 	
    • 
	 * 		"default" has no meaning for required items.
	 * 	
    • 
	 * 		Unlike JSON Schema this value MUST conform to the defined type for the data type.
	 * 
    
	 *
	 * @return The property value, or null if it is not set.
	 */
	public String getDefault() {
		return _default;
	}

	/**
	 * Bean property setter:  default.
	 *
	 * 
    
	 * Declares the value of the item that the server will use if none is provided.
	 *
	 * 
    Notes:
    
	 * 
      
	 * 	
    • 
	 * 		"default" has no meaning for required items.
	 * 	
    • 
	 * 		Unlike JSON Schema this value MUST conform to the defined type for the data type.
	 * 
    
	 *
	 * @param value
	 * 	The new value for this property.
	 * 	
    Can be null to unset the property.
	 * @return This object
	 */
	public ServerVariable setDefault(String value) {
		_default = value;
		return this;
	}

	/**
	 * Bean property getter:  description.
	 *
	 * 
    
	 * Declares the value of the item that the server will use if none is provided.
	 *
	 * 
    Notes:
    
	 * 
      
	 * 	
    • 
	 * 		"description" has no meaning for required items.
	 * 	
    • 
	 * 		Unlike JSON Schema this value MUST conform to the defined type for the data type.
	 * 
    
	 *
	 * @return The property value, or null if it is not set.
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * Bean property setter:  description.
	 *
	 * 
    
	 * Declares the value of the item that the server will use if none is provided.
	 *
	 * 
    Notes:
    
	 * 
      
	 * 	
    • 
	 * 		"description" has no meaning for required items.
	 * 	
    • 
	 * 		Unlike JSON Schema this value MUST conform to the defined type for the data type.
	 * 
    
	 *
	 * @param value
	 * 	The new value for this property.
	 * @return This object
	 */
	public ServerVariable setDescription(String value) {
		description = value;
		return this;
	}

	// 

	// 

	@Override /* OpenApiElement */
	public  T get(String property, Class type) {
		if (property == null)
			return null;
		switch (property) {
			case "enum": return toType(getEnum(), type);
			case "default": return toType(getDefault(), type);
			case "description": return toType(getDescription(), type);
			default: return super.get(property, type);
		}
	}

	@Override /* OpenApiElement */
	public ServerVariable set(String property, Object value) {
		if (property == null)
			return this;
		switch (property) {
			case "default": return setDefault(stringify(value));
			case "enum": return setEnum(listBuilder(Object.class).sparse().addAny(value).build());
			case "description": return setDescription(stringify(value));
			default:
				super.set(property, value);
				return this;
		}
	}

	@Override /* OpenApiElement */
	public Set keySet() {
		Set s = setBuilder(String.class)
				.addIf(_enum != null, "enum")
				.addIf(_default != null,"default" )
				.addIf(description != null, "description")
				.build();
		return new MultiSet<>(s, super.keySet());


	}
}    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy