org.eclipse.rdf4j.rio.RioSetting Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2015 Eclipse RDF4J contributors, Aduna, and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Distribution License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*******************************************************************************/
package org.eclipse.rdf4j.rio;
import java.io.Serializable;
import org.eclipse.rdf4j.rio.helpers.RioConfigurationException;
/**
* Identifies a parser setting along with its default value.
*
* @author Peter Ansell
*/
public interface RioSetting extends Serializable {
/**
* A unique key for this parser setting.
*
* @return A unique key identifying this parser setting.
*/
String getKey();
/**
* The human readable name for this parser setting
*
* @return The name for this parser setting.
*/
String getDescription();
/**
* Returns the default value for this parser setting if it is not set by a user.
*
* @return The default value for this parser setting.
*/
T getDefaultValue();
/**
* Attempts to convert from a string to a type-safe representation based on the generic type of this setting.
*
* @param stringRepresentation a string representation of a value for this setting.
* @return The corresponding object of type T for the supplied string value.
* @throws RioConfigurationException if the setting type does not provide conversion from a string to the expected
* type.
*/
default T convert(String stringRepresentation) {
throw new RioConfigurationException("Conversion not implemented for setting: " + getKey());
}
}