io.muserver.openapi

Class LicenseObjectBuilder

java.lang.Object

io.muserver.openapi.LicenseObjectBuilder

public class LicenseObjectBuilder
extends Object

License information for the exposed API.

Constructor Summary

Constructors

Constructor and Description
LicenseObjectBuilder()

Method Summary

Modifier and Type	Method and Description
static LicenseObject	Apache2_0()
LicenseObject	build()
static LicenseObjectBuilder	licenseObject() Creates a builder for a LicenseObject
static LicenseObject	MITLicense()
static LicenseObject	TheUnlicense()
LicenseObjectBuilder	withName(String name)
LicenseObjectBuilder	withUrl(URI url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LicenseObjectBuilder

public LicenseObjectBuilder()

Method Detail

withName

public LicenseObjectBuilder withName(String name)

Parameters:

name - REQUIRED. The license name used for the API.

Returns:

The current builder

withUrl

public LicenseObjectBuilder withUrl(URI url)

Parameters:

url - A URL to the license used for the API.

Returns:

The current builder

build

public LicenseObject build()

licenseObject

public static LicenseObjectBuilder licenseObject()

Creates a builder for a LicenseObject

Returns:

A new builder

Apache2_0

public static LicenseObject Apache2_0()

Returns:

A license with name "Apache 2.0" and URL http://www.apache.org/licenses/LICENSE-2.0.html

MITLicense

public static LicenseObject MITLicense()

Returns:

A license with name "MIT License" and URL https://opensource.org/licenses/mit-license.php

TheUnlicense

public static LicenseObject TheUnlicense()

Returns:

A license with name "The Unlicense" and URL https://unlicense.org