com.github.mjeanroy.dbunit.yaml.YamlParserFactory Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2015-2019 Mickael Jeanroy
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall 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 com.github.mjeanroy.dbunit.yaml;

import com.github.mjeanroy.dbunit.commons.reflection.ClassUtils;

/**
 * The goal of this factory is to create default instances of {@link YamlParser}.
 */
public final class YamlParserFactory {

	/**
	 * Determines whether JACKSON 2 is available in the classpath.
	 */
	private static final boolean JACKSON_YAML_AVAILABLE = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.yaml.YAMLFactory");

	/**
	 * Determines whether GSON is available in the classpath.
	 */
	private static final boolean SNAKE_YAML_AVAILABLE = ClassUtils.isPresent("org.yaml.snakeyaml.Yaml");

	// Ensure non instantiation.
	private YamlParserFactory() {
	}

	/**
	 * Create default parser.
	 * Implementation will be selected using classpath detection:
	 * 
	 *   If Jackson2 is available on classpath, then it is selected.
	 *   If Gson is available on classpath, then it is selected.
	 *   If Jackson1 is available on classpath, then it is selected.
	 *   If none of these dependencies are available, an instance of {@link UnsupportedOperationException} is thrown.
	 * 
	 *
	 * @return The created parser.
	 */
	public static YamlParser createDefault() {
		if (JACKSON_YAML_AVAILABLE) {
			return new JacksonYamlParser();
		}

		if (SNAKE_YAML_AVAILABLE) {
			return new SnakeYamlParser();
		}

		throw new UnsupportedOperationException(
			"Cannot create YAML parser, please add jackson (com.fasterxml.jackson.dataformat.jackson-dataformat-yaml) or " +
			"SnakeYAML (org.yaml.snakeyaml) to your classpath"
		);
	}
}