org.apache.juneau.dto.openapi3.Info 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.dto.swagger.Contact;
import org.apache.juneau.dto.swagger.License;
import org.apache.juneau.internal.*;
import java.util.Set;
/**
* The object provides metadata about the API.
*
*
* The metadata can be used by the clients if needed, and can be presented
* in the Swagger-UI for convenience.
*
*
Example:
*
* // Construct using SwaggerBuilder.
* Info x = info ("Swagger Sample App" , "1.0.1" )
* .description("This is a sample server Petstore server." )
* .termsOfService("http://swagger.io/terms/" )
* .contact(
* contact ("API Support" , "http://www.swagger.io/support" , "[email protected]" )
* )
* .license(
* license ("Apache 2.0" , "http://www.apache.org/licenses/LICENSE-2.0.html" )
* );
*
* // Serialize using JsonSerializer.
* String json = JsonSerializer.DEFAULT .toString(x);
*
* // Or just use toString() which does the same as above.
* String json = x.toString();
*
*
* // Output
* {
* "title" : "Swagger Sample App" ,
* "description" : "This is a sample server Petstore server." ,
* "termsOfService" : "http://swagger.io/terms/" ,
* "contact" : {
* "name" : "API Support" ,
* "url" : "http://www.swagger.io/support" ,
* "email" : "[email protected]"
* },
* "license" : {
* "name" : "Apache 2.0" ,
* "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
* },
* "version" : "1.0.1"
* }
*
*/
@Bean(properties="title,description,version,contact,license,termsOfService,*")
@FluentSetters
public class Info extends OpenApiElement {
private String
title,
description,
termsOfService,
version;
private Contact contact;
private License license;
/**
* Default constructor.
*/
public Info() {}
/**
* Copy constructor.
*
* @param copyFrom The object to copy.
*/
public Info(Info copyFrom) {
super(copyFrom);
this.title = copyFrom.title;
this.description = copyFrom.description;
this.termsOfService = copyFrom.termsOfService;
this.version = copyFrom.version;
this.contact = copyFrom.contact == null ? null : copyFrom.contact.copy();
this.license = copyFrom.license == null ? null : copyFrom.license.copy();
}
/**
* Make a deep copy of this object.
*
* @return A deep copy of this object.
*/
public Info copy() {
return new Info(this);
}
/**
* Bean property getter: title .
*
*
* The title of the application.
*
* @return The property value, or null if it is not set.
*/
public String getTitle() {
return title;
}
/**
* Bean property setter: title .
*
*
* The title of the application.
*
* @param value
* The new value for this property.
*
Property value is required.
* @return This object
*/
public Info setTitle(String value) {
title = value;
return this;
}
/**
* Bean property getter: description .
*
*
* A short description of the application.
*
* @return The property value, or null if it is not set.
*/
public String getDescription() {
return description;
}
/**
* Bean property setter: description .
*
*
* A short description of the application.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Info setDescription(String value) {
description = value;
return this;
}
/**
* Bean property getter: termsOfService .
*
*
* The Terms of Service for the API.
*
* @return The property value, or null if it is not set.
*/
public String getTermsOfService() {
return termsOfService;
}
/**
* Bean property setter: termsOfService .
*
*
* The Terms of Service for the API.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Info setTermsOfService(String value) {
termsOfService = value;
return this;
}
/**
* Bean property getter: contact .
*
*
* The contact information for the exposed API.
*
* @return The property value, or null if it is not set.
*/
public Contact getContact() {
return contact;
}
/**
* Bean property setter: contact .
*
*
* The contact information for the exposed API.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Info setContact(Contact value) {
contact = value;
return this;
}
/**
* Bean property getter: license .
*
*
* The license information for the exposed API.
*
* @return The property value, or null if it is not set.
*/
public License getLicense() {
return license;
}
/**
* Bean property setter: license .
*
*
* The license information for the exposed API.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Info setLicense(License value) {
license = value;
return this;
}
/**
* Bean property getter: version .
*
*
* Provides the version of the application API (not to be confused with the specification version).
*
* @return The property value, or null if it is not set.
*/
public String getVersion() {
return version;
}
/**
* Bean property setter: version .
*
*
* Provides the version of the application API (not to be confused with the specification version).
*
* @param value
* The new value for this property.
*
Property value is required.
* @return This object
*/
public Info setVersion(String value) {
version = value;
return this;
}
//
//
@Override /* OpenApiElement */
public T get(String property, Class type) {
if (property == null)
return null;
switch (property) {
case "title": return toType(getTitle(), type);
case "description": return toType(getDescription(), type);
case "termsOfService": return toType(getTermsOfService(), type);
case "contact": return toType(getContact(), type);
case "license": return toType(getLicense(), type);
case "version": return toType(getVersion(), type);
default: return super.get(property, type);
}
}
@Override /* OpenApiElement */
public Info set(String property, Object value) {
if (property == null)
return this;
switch (property) {
case "title": return setTitle(stringify(value));
case "description": return setDescription(stringify(value));
case "termsOfService": return setTermsOfService(stringify(value));
case "contact": return setContact(toType(value, Contact.class));
case "license": return setLicense(toType(value, License.class));
case "version": return setVersion(stringify(value));
default:
super.set(property, value);
return this;
}
}
@Override /* OpenApiElement */
public Set keySet() {
Set s = setBuilder(String.class)
.addIf(title != null, "title")
.addIf(description != null, "description")
.addIf(termsOfService != null, "termsOfService")
.addIf(contact != null, "contact")
.addIf(license != null, "license")
.addIf(version != null, "version")
.build();
return new MultiSet<>(s, super.keySet());
}
}