org.snakeyaml.engine.v2.api.LoadSettingsBuilder Maven / Gradle / Ivy
Show all versions of snakeyaml-engine Show documentation
/*
* Copyright (c) 2018, SnakeYAML
*
* Licensed 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.snakeyaml.engine.v2.api;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.IntFunction;
import java.util.function.UnaryOperator;
import org.snakeyaml.engine.v2.common.SpecVersion;
import org.snakeyaml.engine.v2.env.EnvConfig;
import org.snakeyaml.engine.v2.exceptions.YamlVersionException;
import org.snakeyaml.engine.v2.nodes.Tag;
import org.snakeyaml.engine.v2.schema.JsonSchema;
import org.snakeyaml.engine.v2.schema.Schema;
/**
* Builder pattern implementation for LoadSettings
*/
public final class LoadSettingsBuilder {
private final Map customProperties = new HashMap<>();
private String label;
private Map tagConstructors;
private IntFunction> defaultList;
private IntFunction> defaultSet;
private IntFunction> defaultMap;
private UnaryOperator versionFunction;
private Integer bufferSize;
private boolean allowDuplicateKeys;
private boolean allowRecursiveKeys;
private boolean parseComments;
private int maxAliasesForCollections;
private boolean useMarks;
private Optional envConfig;
private int codePointLimit;
private Schema schema;
/**
* Create builder
*/
LoadSettingsBuilder() {
this.label = "reader";
this.tagConstructors = new HashMap<>();
this.defaultList = ArrayList::new; // same as new ArrayList(initSize)
this.defaultSet = LinkedHashSet::new; // same as new LinkedHashSet(initSize)
// respect order from YAML document
this.defaultMap = LinkedHashMap::new; // same as new LinkedHashMap(initSize)
this.versionFunction = version -> {
if (version.getMajor() != 1) {
throw new YamlVersionException(version);
}
return version;
};
this.bufferSize = 1024;
this.allowDuplicateKeys = false;
this.allowRecursiveKeys = false;
this.parseComments = false;
// to prevent YAML at https://en.wikipedia.org/wiki/Billion_laughs_attack
this.maxAliasesForCollections = 50;
this.useMarks = true;
this.envConfig = Optional.empty(); // no ENV substitution by default
this.codePointLimit = 3 * 1024 * 1024; // 3 MB
this.schema = new JsonSchema();
}
/**
* Label for the input data. Can be used to improve the error message.
*
* @param label - meaningful label to indicate the input source
* @return the builder with the provided value
*/
public LoadSettingsBuilder setLabel(String label) {
Objects.requireNonNull(label, "label cannot be null");
this.label = label;
return this;
}
/**
* Provide constructors for the specified tags.
*
* @param tagConstructors - the map from a Tag to its constructor
* @return the builder with the provided value
*/
public LoadSettingsBuilder setTagConstructors(Map tagConstructors) {
this.tagConstructors = tagConstructors;
return this;
}
/**
* Provide default List implementation. {@link ArrayList} is used if nothing provided.
*
* @param defaultList - specified List implementation (as a function from init size)
* @return the builder with the provided value
*/
public LoadSettingsBuilder setDefaultList(IntFunction> defaultList) {
Objects.requireNonNull(defaultList, "defaultList cannot be null");
this.defaultList = defaultList;
return this;
}
/**
* Provide default Set implementation. {@link LinkedHashSet} is used if nothing provided.
*
* @param defaultSet - specified Set implementation (as a function from init size)
* @return the builder with the provided value
*/
public LoadSettingsBuilder setDefaultSet(IntFunction> defaultSet) {
Objects.requireNonNull(defaultSet, "defaultSet cannot be null");
this.defaultSet = defaultSet;
return this;
}
/**
* Provide default Map implementation. {@link LinkedHashMap} is used if nothing provided.
*
* @param defaultMap - specified Map implementation (as a function from init size)
* @return the builder with the provided value
*/
public LoadSettingsBuilder setDefaultMap(IntFunction> defaultMap) {
Objects.requireNonNull(defaultMap, "defaultMap cannot be null");
this.defaultMap = defaultMap;
return this;
}
/**
* Buffer size for incoming data stream. If the incoming stream is already buffered, then changing
* the buffer does not improve the performance
*
* @param bufferSize - buffer size (in bytes) for input data
* @return the builder with the provided value
*/
public LoadSettingsBuilder setBufferSize(Integer bufferSize) {
this.bufferSize = bufferSize;
return this;
}
/**
* YAML 1.2 does require unique keys. To support the backwards compatibility it is possible to
* select what should happen when non-unique keys are detected.
*
* @param allowDuplicateKeys - if true, then the non-unique keys in a mapping are allowed (last
* key wins). False by default.
* @return the builder with the provided value
*/
public LoadSettingsBuilder setAllowDuplicateKeys(boolean allowDuplicateKeys) {
this.allowDuplicateKeys = allowDuplicateKeys;
return this;
}
/**
* Allow only non-recursive keys for maps and sets. By default, is it not allowed. Even though
* YAML allows to use anything as a key, it may cause unexpected issues when loading recursive
* structures.
*
* @param allowRecursiveKeys - true to allow recursive structures as keys
* @return the builder with the provided value
*/
public LoadSettingsBuilder setAllowRecursiveKeys(boolean allowRecursiveKeys) {
this.allowRecursiveKeys = allowRecursiveKeys;
return this;
}
/**
* Restrict the number of aliases for collection nodes to prevent a Billion laughs attack. The
* purpose of this setting is to force SnakeYAML to fail before a lot of CPU and memory resources
* are allocated for the parser. Aliases for scalar nodes do not count because they do not grow
* exponentially.
*
* @param maxAliasesForCollections - max number of aliases. More than 50 might be very dangerous.
* Default is 50
* @return the builder with the provided value
*/
public LoadSettingsBuilder setMaxAliasesForCollections(int maxAliasesForCollections) {
this.maxAliasesForCollections = maxAliasesForCollections;
return this;
}
/**
* Marks are only used for error messages. But they require a lot of memory. True by default.
*
* @param useMarks - use false to save resources but use less informative error messages (no line
* and context)
* @return the builder with the provided value
*/
public LoadSettingsBuilder setUseMarks(boolean useMarks) {
this.useMarks = useMarks;
return this;
}
/**
* Manage YAML directive value which defines the version of the YAML specification. This parser
* supports YAML 1.2 but it can parse most of YAML 1.1 and YAML 1.0
*
* This function allows to control the version management. For instance if the document contains
* old version the parser can be adapted to compensate the problem. Or it can fail to indicate
* that the incoming version is not supported.
*
* @param versionFunction - define the way to manage the YAML version. By default, 1.* versions
* are accepted and treated as YAML 1.2. Other versions fail to parse (YamlVersionException
* is thown)
* @return the builder with the provided value
*/
public LoadSettingsBuilder setVersionFunction(UnaryOperator versionFunction) {
Objects.requireNonNull(versionFunction, "versionFunction cannot be null");
this.versionFunction = versionFunction;
return this;
}
/**
* Define EnvConfig to parse ENV format. If not set explicitly the variable substitution is not
* applied.
*
* @param envConfig - non-empty configuration to substitute variables
* @return the builder with the provided value
* @see Variable
* substitution
*/
public LoadSettingsBuilder setEnvConfig(Optional envConfig) {
this.envConfig = envConfig;
return this;
}
/**
* Provide a custom property to be used later
*
* @param key - the key
* @param value - the value behind the key
* @return the builder with the provided value
*/
public LoadSettingsBuilder setCustomProperty(SettingKey key, Object value) {
customProperties.put(key, value);
return this;
}
/**
* Parse comments to the presentation tree (Node). False by default
*
* @param parseComments - use true to parse comments to the presentation tree (Node)
* @return the builder with the provided value
*/
public LoadSettingsBuilder setParseComments(boolean parseComments) {
this.parseComments = parseComments;
return this;
}
/**
* The max amount of code points for every input YAML document in the stream. Please be aware that
* byte limit depends on the encoding.
*
* @param codePointLimit - the max allowed size of a single YAML document in a stream
* @return the builder with the provided value
*/
public LoadSettingsBuilder setCodePointLimit(int codePointLimit) {
this.codePointLimit = codePointLimit;
return this;
}
/**
* Provide either recommended or custom
* schema instead of
* default * {@link org.snakeyaml.engine.v2.schema.CoreSchema} These 3 are available
* {@link org.snakeyaml.engine.v2.schema.FailsafeSchema},
* {@link org.snakeyaml.engine.v2.schema.JsonSchema},
* {@link org.snakeyaml.engine.v2.schema.CoreSchema}.
*
* @param schema to be used for parsing
* @return the builder with the provided value
*/
public LoadSettingsBuilder setSchema(Schema schema) {
this.schema = schema;
return this;
}
/**
* Build immutable LoadSettings
*
* @return immutable LoadSettings
*/
public LoadSettings build() {
return new LoadSettings(label, tagConstructors, defaultList, defaultSet, defaultMap,
versionFunction, bufferSize, allowDuplicateKeys, allowRecursiveKeys,
maxAliasesForCollections, useMarks, customProperties, envConfig, parseComments,
codePointLimit, schema);
}
}