com.alibaba.antx.util.configuration.AbstractConfiguration Maven / Gradle / Ivy
/*
* Copyright (c) 2002-2012 Alibaba Group Holding Limited.
* All rights reserved.
*
* 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 com.alibaba.antx.util.configuration;
/**
* This is an abstract Configuration implementation that deals with
* methods that can be abstracted away from underlying implementations.
*
* @author Avalon Development Team
*/
public abstract class AbstractConfiguration implements Configuration {
/**
* Returns the prefix of the namespace. This is only used as a serialization
* hint, therefore is not part of the client API. It should be included in
* all Configuration implementations though.
*
* @return A non-null String (defaults to "")
* @throws ConfigurationException if no prefix was defined (prefix is
* null.
* @since 4.1
*/
protected abstract String getPrefix() throws ConfigurationException;
/**
* Returns the value of the configuration element as an int.
* Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary
* numbers begin with 0b, all other values are assumed to be decimal.
*
* @return the value
* @throws ConfigurationException if an error occurs
*/
public int getValueAsInteger() throws ConfigurationException {
final String value = getValue().trim();
try {
if (value.startsWith("0x")) {
return Integer.parseInt(value.substring(2), 16);
} else if (value.startsWith("0o")) {
return Integer.parseInt(value.substring(2), 8);
} else if (value.startsWith("0b")) {
return Integer.parseInt(value.substring(2), 2);
} else {
return Integer.parseInt(value);
}
} catch (final Exception nfe) {
final String message = "Cannot parse the value \"" + value
+ "\" as an integer in the configuration element \"" + getName() + "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
/**
* Returns the value of the configuration element as an int.
* Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary
* numbers begin with 0b, all other values are assumed to be decimal.
*
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public int getValueAsInteger(final int defaultValue) {
try {
return getValueAsInteger();
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the configuration element as a long.
* Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary
* numbers begin with 0b, all other values are assumed to be decimal.
*
* @return the value
* @throws ConfigurationException if an error occurs
*/
public long getValueAsLong() throws ConfigurationException {
final String value = getValue().trim();
try {
if (value.startsWith("0x")) {
return Long.parseLong(value.substring(2), 16);
} else if (value.startsWith("0o")) {
return Long.parseLong(value.substring(2), 8);
} else if (value.startsWith("0b")) {
return Long.parseLong(value.substring(2), 2);
} else {
return Long.parseLong(value);
}
} catch (final Exception nfe) {
final String message = "Cannot parse the value \"" + value + "\" as a long in the configuration element \""
+ getName() + "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
/**
* Returns the value of the configuration element as a long.
* Hexadecimal numbers begin with 0x, Octal numbers begin with 0o and binary
* numbers begin with 0b, all other values are assumed to be decimal.
*
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public long getValueAsLong(final long defaultValue) {
try {
return getValueAsLong();
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the configuration element as a float.
*
* @return the value
* @throws ConfigurationException if an error occurs
*/
public float getValueAsFloat() throws ConfigurationException {
final String value = getValue().trim();
try {
return Float.parseFloat(value);
} catch (final Exception nfe) {
final String message = "Cannot parse the value \"" + value
+ "\" as a float in the configuration element \"" + getName() + "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
/**
* Returns the value of the configuration element as a float.
*
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public float getValueAsFloat(final float defaultValue) {
try {
return getValueAsFloat();
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the configuration element as a boolean.
*
* @return the value
* @throws ConfigurationException if an error occurs
*/
public boolean getValueAsBoolean() throws ConfigurationException {
final String value = getValue().trim();
if (isTrue(value)) {
return true;
} else if (isFalse(value)) {
return false;
} else {
final String message = "Cannot parse the value \"" + value
+ "\" as a boolean in the configuration element \"" + getName() + "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
/**
* Returns the value of the configuration element as a boolean.
*
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public boolean getValueAsBoolean(final boolean defaultValue) {
try {
return getValueAsBoolean();
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the configuration element as a String.
*
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public String getValue(final String defaultValue) {
try {
return getValue();
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the attribute specified by its name as an
* int. Hexadecimal numbers begin with 0x, Octal numbers begin
* with 0o and binary numbers begin with 0b, all other values are assumed to
* be decimal.
*
* @param name the name of the attribute
* @return the value
* @throws ConfigurationException if an error occurs
*/
public int getAttributeAsInteger(final String name) throws ConfigurationException {
final String value = getAttribute(name).trim();
try {
if (value.startsWith("0x")) {
return Integer.parseInt(value.substring(2), 16);
} else if (value.startsWith("0o")) {
return Integer.parseInt(value.substring(2), 8);
} else if (value.startsWith("0b")) {
return Integer.parseInt(value.substring(2), 2);
} else {
return Integer.parseInt(value);
}
} catch (final Exception nfe) {
final String message = "Cannot parse the value \"" + value + "\" as an integer in the attribute \"" + name
+ "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
/**
* Returns the value of the attribute specified by its name as an
* int. Hexadecimal numbers begin with 0x, Octal numbers begin
* with 0o and binary numbers begin with 0b, all other values are assumed to
* be decimal.
*
* @param name the name of the attribute
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public int getAttributeAsInteger(final String name, final int defaultValue) {
try {
return getAttributeAsInteger(name);
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the attribute specified by its name as a
* long. Hexadecimal numbers begin with 0x, Octal numbers begin
* with 0o and binary numbers begin with 0b, all other values are assumed to
* be decimal.
*
* @param name the name of the attribute
* @return the value
* @throws ConfigurationException if an error occurs
*/
public long getAttributeAsLong(final String name) throws ConfigurationException {
final String value = getAttribute(name);
try {
if (value.startsWith("0x")) {
return Long.parseLong(value.substring(2), 16);
} else if (value.startsWith("0o")) {
return Long.parseLong(value.substring(2), 8);
} else if (value.startsWith("0b")) {
return Long.parseLong(value.substring(2), 2);
} else {
return Long.parseLong(value);
}
} catch (final Exception nfe) {
final String message = "Cannot parse the value \"" + value + "\" as a long in the attribute \"" + name
+ "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
/**
* Returns the value of the attribute specified by its name as a
* long. Hexadecimal numbers begin with 0x, Octal numbers begin
* with 0o and binary numbers begin with 0b, all other values are assumed to
* be decimal.
*
* @param name the name of the attribute
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public long getAttributeAsLong(final String name, final long defaultValue) {
try {
return getAttributeAsLong(name);
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the attribute specified by its name as a
* float.
*
* @param name the name of the attribute
* @return the value
* @throws ConfigurationException if an error occurs
*/
public float getAttributeAsFloat(final String name) throws ConfigurationException {
final String value = getAttribute(name);
try {
return Float.parseFloat(value);
} catch (final Exception e) {
final String message = "Cannot parse the value \"" + value + "\" as a float in the attribute \"" + name
+ "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
/**
* Returns the value of the attribute specified by its name as a
* float.
*
* @param name the name of the attribute
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public float getAttributeAsFloat(final String name, final float defaultValue) {
try {
return getAttributeAsFloat(name);
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the attribute specified by its name as a
* boolean.
*
* @param name the name of the attribute
* @return the value
* @throws ConfigurationException if an error occurs
*/
public boolean getAttributeAsBoolean(final String name) throws ConfigurationException {
final String value = getAttribute(name);
if (isTrue(value)) {
return true;
} else if (isFalse(value)) {
return false;
} else {
final String message = "Cannot parse the value \"" + value + "\" as a boolean in the attribute \"" + name
+ "\" at " + getLocation();
throw new ConfigurationException(message);
}
}
private boolean isTrue(final String value) {
return value.equalsIgnoreCase("true") || value.equalsIgnoreCase("yes") || value.equalsIgnoreCase("on")
|| value.equalsIgnoreCase("1");
}
private boolean isFalse(final String value) {
return value.equalsIgnoreCase("false") || value.equalsIgnoreCase("no") || value.equalsIgnoreCase("off")
|| value.equalsIgnoreCase("0");
}
/**
* Returns the value of the attribute specified by its name as a
* boolean.
*
* @param name the name of the attribute
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public boolean getAttributeAsBoolean(final String name, final boolean defaultValue) {
try {
return getAttributeAsBoolean(name);
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Returns the value of the attribute specified by its name as a
* String.
*
* @param name the name of the attribute
* @param defaultValue the default value to return if value malformed or
* empty
* @return the value
*/
public String getAttribute(final String name, final String defaultValue) {
try {
return getAttribute(name);
} catch (final ConfigurationException ce) {
return defaultValue;
}
}
/**
* Return the first Configuration object child of this
* associated with the given name. If no such child exists, a new one will
* be created.
*
* @param name the name of the child
* @return the child Configuration
*/
public Configuration getChild(final String name) {
return getChild(name, true);
}
/**
* Return the first Configuration object child of this
* associated with the given name.
*
* @param name the name of the child
* @param createNew true if you want to create a new Configuration object if
* none exists
* @return the child Configuration
*/
public Configuration getChild(final String name, final boolean createNew) {
final Configuration[] children = getChildren(name);
if (children.length > 0) {
return children[0];
} else {
if (createNew) {
return new DefaultConfiguration(name, Location.EMPTY_LOCATION);
} else {
return null;
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy