org.pkl.thirdparty.graalvm.options.OptionDescriptor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation
Show all versions of pkl-tools Show documentation
Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.
/*
* Copyright (c) 2017, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.pkl.thirdparty.graalvm.options;
import java.util.Objects;
/**
* Represents metadata for a single option.
*
* @since 19.0
*/
public final class OptionDescriptor {
private final OptionKey key;
private final String name;
private final String help;
private final OptionCategory category;
private final OptionStability stability;
private final boolean deprecated;
private final String deprecationMessage;
private final String usageSyntax;
OptionDescriptor(OptionKey key, String name, String help, OptionCategory category, OptionStability stability, boolean deprecated, String deprecationMessage, String usageSyntax) {
this.key = key;
this.name = name;
this.help = help;
this.category = category;
this.stability = stability;
this.deprecated = deprecated;
this.deprecationMessage = deprecationMessage;
this.usageSyntax = usageSyntax;
}
/**
* Returns the name of the option that this descriptor represents.
*
* @since 19.0
*/
public String getName() {
return name;
}
/**
* Returns the key for this option.
*
* @since 19.0
*/
public OptionKey getKey() {
return key;
}
/**
* Returns true if this option was marked deprecated. This indicates that the
* option is going to be removed in a future release or its use is not recommended.
*
* @since 19.0
*/
public boolean isDeprecated() {
return deprecated;
}
/**
* Returns the deprecation reason and the recommended fix. For newlines, use %n.
*
* @since 20.1.0
*/
public String getDeprecationMessage() {
return deprecationMessage;
}
/**
* Returns true if this option is an option map. Options maps allow to collect
* key=value pairs whose keys are unknown beforehand e.g. user defined properties.
*
* @since 19.2
*/
public boolean isOptionMap() {
return getKey().getType().isOptionMap();
}
/**
* Returns the user category of this option.
*
* @since 19.0
*/
public OptionCategory getCategory() {
return category;
}
/**
* Returns the stability of this option.
*
* @since 19.0
*/
public OptionStability getStability() {
return stability;
}
/**
* Returns a human-readable description on how to use the option. For newlines, use
* %n.
*
* @since 19.0
*/
public String getHelp() {
return help;
}
/**
* Specifies a human-readable syntax describing the accepted values for this option.
*
* @return null if no usage syntax should be used, the usage syntax otherwise
*
* @since 22.1
*/
public String getUsageSyntax() {
// Empty string is considered a 'not set' value, everything else, including null, is fair
// game
if (usageSyntax == null || !usageSyntax.isEmpty()) {
return usageSyntax;
}
if (!key.getType().isDefaultType()) {
return "";
}
Object defaultValue = getKey().getDefaultValue();
if (Boolean.FALSE.equals(defaultValue)) {
return null;
}
if (Boolean.TRUE.equals(defaultValue)) {
return "true|false";
}
if (isOptionMap()) {
return "";
}
Class aClass = defaultValue.getClass();
if (Enum.class.isAssignableFrom(aClass)) {
return enumUsageSyntax(defaultValue, aClass);
}
return "";
}
@SuppressWarnings({"unchecked", "rawtypes"})
private static String enumUsageSyntax(Object defaultValue, Class aClass) {
StringBuilder sb = new StringBuilder();
Class enumType = (Class) aClass;
Enum[] enumConstants = enumType.getEnumConstants();
// Append the default value first
for (Enum constant : enumConstants) {
if (defaultValue.equals(constant)) {
sb.append(constant);
break;
}
}
// Append the other values
for (Enum constant : enumConstants) {
if (!defaultValue.equals(constant)) {
sb.append("|");
sb.append(constant.toString());
}
}
return sb.toString();
}
/**
* {@inheritDoc}
*
* @since 19.0
*/
@Override
public String toString() {
return "OptionDescriptor [key=" + key + ", help=" + help + ", usageSyntax=" + usageSyntax + ", category=" + category + ", deprecated=" + deprecated + ", optionMap=" + isOptionMap() + "]";
}
/**
* {@inheritDoc}
*
* @since 19.0
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + (deprecated ? 1231 : 1237);
result = prime * result + ((help == null) ? 0 : help.hashCode());
result = prime * result + ((key == null) ? 0 : key.hashCode());
result = prime * result + ((category == null) ? 0 : category.hashCode());
result = prime * result + ((name == null) ? 0 : name.hashCode());
return result;
}
/**
* {@inheritDoc}
*
* @since 19.0
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
} else if (obj == null) {
return false;
} else if (getClass() != obj.getClass()) {
return false;
}
OptionDescriptor other = (OptionDescriptor) obj;
return Objects.equals(name, other.name) &&
Objects.equals(deprecated, other.deprecated) &&
Objects.equals(help, other.help) &&
Objects.equals(key, other.key) &&
Objects.equals(category, other.category);
}
/**
* Creates a new option descriptor builder by key. The option group and name is inferred by the
* key.
*
* @since 19.0
*/
public static Builder newBuilder(OptionKey key, String name) {
Objects.requireNonNull(key);
Objects.requireNonNull(name);
return EMPTY.new Builder(key, name);
}
private static final OptionDescriptor EMPTY = new OptionDescriptor(null, null, null, null, null, false, null, "");
/**
* Represents an option descriptor builder.
*
* @since 19.0
*/
public final class Builder {
private final OptionKey key;
private final String name;
private boolean deprecated = false;
private String deprecationMessage = "";
private OptionCategory category = OptionCategory.INTERNAL;
private OptionStability stability = OptionStability.EXPERIMENTAL;
private String help = "";
private String usageSyntax = "";
Builder(OptionKey key, String name) {
this.key = key;
this.name = name;
}
/**
* Defines the user category for this option. The default value is
* {@link OptionCategory#INTERNAL}.
*
* @since 19.0
*/
public Builder category(@SuppressWarnings("hiding") OptionCategory category) {
Objects.requireNonNull(category);
this.category = category;
return this;
}
/**
* Defines the stability of this option. The default value is
* {@link OptionStability#EXPERIMENTAL}.
*
* @since 19.0
*/
public Builder stability(@SuppressWarnings("hiding") OptionStability stability) {
Objects.requireNonNull(stability);
this.stability = stability;
return this;
}
/**
* Defines if this option is deprecated. The default value for deprecated is
* false. This can be used to evolve options between releases.
*
* @since 19.0
*/
public Builder deprecated(@SuppressWarnings("hiding") boolean deprecated) {
this.deprecated = deprecated;
return this;
}
/**
* Specifies a human-readable description on how to use the option.
*
* @since 19.0
*/
public Builder help(@SuppressWarnings("hiding") String help) {
Objects.requireNonNull(help);
this.help = help;
return this;
}
/**
* Specifies a human-readable syntax describing the accepted values for this option.
*
* @since 22.1
*/
public Builder usageSyntax(@SuppressWarnings("hiding") String usageSyntax) {
this.usageSyntax = usageSyntax;
return this;
}
/**
* Specifies a human-readable deprecation reason and the recommended fix.
*
* @since 20.1.0
*/
public Builder deprecationMessage(@SuppressWarnings("hiding") String deprecationMessage) {
Objects.requireNonNull(deprecationMessage);
this.deprecationMessage = deprecationMessage;
return this;
}
/**
* Builds and returns a new option descriptor.
*
* @since 19.0
*/
public OptionDescriptor build() {
return new OptionDescriptor(key, name, help, category, stability, deprecated, deprecationMessage, usageSyntax);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy