Configuration (ODPS SDK Commons for Mapreduce/Graph 0.45.2-public API)

java.lang.Object
- com.aliyun.odps.conf.Configuration

All Implemented Interfaces:

Writable, Iterable<Map.Entry<String,String>>
```
public class Configuration
extends Object
implements Iterable<Map.Entry<String,String>>, Writable
```
配置类，提供读取和设置配置参数的方法.
配置文件

支持从配置文件中读取配置信息或写出配置信息，配置文件是标准的 XML，包含一组 name/value 对，示例如下：
```
 <configuration>
  <property>
   <name>com.mycomp.xxx</name>
   <value>xxx</value>
  </property>
  ... ...
 </configuration>
 
```
通过writeXml(OutputStream) 可以将配置信息输入到文件。

变量引用

配置项的值可以使用变量引用，例如：${user.name}，变量替换的规则：
1. 首先，检查变量名是否是 System.getProperties() 的系统参数，如果是，则使用系统参数的取值。
2. 如果变量名不是系统参数，检查是否已定义的配置项，如果是，则使用已定义配置项的取值。
变量引用示例：
```
  <property>
    <name>basedir</name>
    <value>/user/${user.name}</value>
  </property>

  <property>
    <name>tempdir</name>
    <value>${basedir}/tmp</value>
  </property>
 
```

Constructor Summary

Constructors
Constructor and Description
`Configuration()` 默认Configuration构造方法，这个方法会载入默认配置。
`Configuration(boolean loadDefaults)` Configuration构造方法，这个方法可以指定是否载入默认配置。如果参数`loadDefaults` 是false，构造的实例不会从文件中载入默认配置。
`Configuration(Configuration other)` Configuration的拷贝构造方法。

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addDefaultResource(String name)` 增加一个默认配置。默认配置是按照增加的顺序来读取的。
`void`	`addResource(InputStream in)` 增加一个配置。新配置会覆盖默认配置，除非配置参数被设定为 final.
`void`	`addResource(String name)` 增加一个配置。新配置会覆盖默认配置，除非配置参数被设定为 final.
`void`	`addResource(URL url)` 增加一个配置。新配置会覆盖默认配置，除非配置参数被设定为 final.
`void`	`clear()` 清除所有配置
`String`	`get(String name)` 获取参数`name`的值，如果不存在，返回`null`。参数值会使用变量展开。
`String`	`get(String name, String defaultValue)` 获取参数`name`的值，如果不存在，返回`defaultValue`。
`boolean`	`getBoolean(String name, boolean defaultValue)` 获取参数`name`的布尔值，如果不存在，返回`defaultValue`。
`Class<?>`	`getClass(String name, Class<?> defaultValue)` 获取参数`name`指定的类对象，如果不存在，返回`defaultValue`。如果类未能找到，则会抛出RuntimeException。
`<U> Class<? extends U>`	`getClass(String name, Class<? extends U> defaultValue, Class<U> xface)` 获取参数`name`指定的类对象，这个类实现的接口由 `xface`指定。如果不存在，返回`defaultValue`。
`Class<?>`	`getClassByName(String name)` 根据类名载入Java类
`Class<?>[]`	`getClasses(String name, Class<?>... defaultValue)` 获取参数`name`指定的类对象数组，如果不存在，返回`defaultValue`。如果类未能找到，则会抛出RuntimeException。
`ClassLoader`	`getClassLoader()` 获取`ClassLoader`
`InputStream`	`getConfResourceAsInputStream(String name)` 获取一个指定配置文件的 `InputStream`
`Reader`	`getConfResourceAsReader(String name)` 获取一个指定配置文件的 `Reader`
`File`	`getFile(String dirsProp, String path)` 获取一个本地文件，其父目录由名称为 dirsProp 的参数指定，路径为 path.
`float`	`getFloat(String name, float defaultValue)` 获取参数`name`的浮点值，如果不存在，返回`defaultValue`。
`int`	`getInt(String name, int defaultValue)` 获取参数`name`的整形值，如果不存在，返回`defaultValue`。
`long`	`getLong(String name, long defaultValue)` 获取参数`name`的长整形值，如果不存在，返回`defaultValue`。
`com.aliyun.odps.conf.Configuration.IntegerRanges`	`getRange(String name, String defaultValue)` 获取参数`name`的值为一个区间，如果不存在，返回`defaultValue`指定的区间。
`String`	`getRaw(String name)` 获取参数`name`的值，不使用变量展开。
`URL`	`getResource(String name)` 获取指定配置文件的`URL`
`Collection<String>`	`getStringCollection(String name)` 获取参数`name`的字符值集合，如果不存在，返回`null`。
`String[]`	`getStrings(String name)` 获取参数`name`的字符数组值，如果不存在，返回`null`。
`String[]`	`getStrings(String name, String... defaultValue)` 获取参数`name`的字符数组值，如果不存在，返回`defaultValue`。
`Iterator<Map.Entry<String,String>>`	`iterator()` 所有配置的迭代器，格式为key/value。key和value的类型都为string。
`void`	`readFields(DataInput in)` 从 `DataInput` 读取
`void`	`reloadConfiguration()` 从已经添加的资源中重新载入`Configuration`。这个方法会清空所有配置，并从配置文件重新载入一份新的配置。
`void`	`set(String name, String value)` 设置参数`name`的值 `value` 。
`void`	`setBoolean(String name, boolean value)` 设定参数 `name` 的布尔值
`void`	`setBooleanIfUnset(String name, boolean value)` 如果参数 `name` 未设定，设定它的布尔值
`void`	`setClass(String name, Class<?> theClass, Class<?> xface)` 设置`name`参数指定的类，这个类实现的接口由 `xface`指定。
`void`	`setClassLoader(ClassLoader classLoader)` 设置`ClassLoader`对象
`void`	`setFloat(String name, float value)` 设定参数 `name` 的浮点值
`void`	`setIfUnset(String name, String value)` 如果指定参数不存在则设定它
`void`	`setInt(String name, int value)` 设定参数 `name` 的整形值
`void`	`setLong(String name, long value)` 设定参数 `name` 的长整形值
`void`	`setQuietMode(boolean quietmode)` 设定quiet模式。quiet模式下，错误等信息不会记录在日志里。
`void`	`setStrings(String name, String... values)` 设置参数`name` 的字符串数组值 `value` 。
`int`	`size()` 配置项的计数
`String`	`toString()`
`void`	`write(DataOutput out)` 输出到 `DataOutput`
`void`	`writeXml(OutputStream out)` 写出所有非默认的参数到一个 `OutputStream`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Configuration
```
public Configuration()
```
    默认Configuration构造方法，这个方法会载入默认配置。
  - Configuration
```
public Configuration(boolean loadDefaults)
```
    Configuration构造方法，这个方法可以指定是否载入默认配置。如果参数loadDefaults 是false，构造的实例不会从文件中载入默认配置。
    
    Parameters:
    
    loadDefaults - 指定是否载入默认配置
  - Configuration
```
public Configuration(Configuration other)
```
    Configuration的拷贝构造方法。
    
    Parameters:
    
    other - 拷贝的初始实例
- Method Detail
  - addDefaultResource
```
public static void addDefaultResource(String name)
```
    增加一个默认配置。默认配置是按照增加的顺序来读取的。
    
    Parameters:
    
    name - 配置文件名。这个文件必须在classpath中。
  - addResource
```
public void addResource(String name)
```
    增加一个配置。新配置会覆盖默认配置，除非配置参数被设定为 final.
    
    Parameters:
    
    name - 配置文件名。这个文件必须在classpath中。
  - addResource
```
public void addResource(URL url)
```
    增加一个配置。新配置会覆盖默认配置，除非配置参数被设定为 final.
    
    Parameters:
    
    url - 配置文件的url名。会从指定url的本地文件系统中获取配置文件。
  - addResource
```
public void addResource(InputStream in)
```
    增加一个配置。新配置会覆盖默认配置，除非配置参数被设定为 final.
    
    Parameters:
    
    in - 配置文件的输入流。
  - reloadConfiguration
```
public void reloadConfiguration()
```
    从已经添加的资源中重新载入Configuration。这个方法会清空所有配置，并从配置文件重新载入一份新的配置。
  - get
```
public String get(String name)
```
    获取参数name的值，如果不存在，返回null。参数值会使用变量展开。
    
    Parameters:
    
    name - 参数名
    
    Returns:
    
    参数name的字符串值, 如果不存在，返回null。
  - getRaw
```
public String getRaw(String name)
```
    获取参数name的值，不使用变量展开。
    
    Parameters:
    
    name - 参数名
    
    Returns:
    
    参数name的值, 如果不存在，返回null。
  - set
```
public void set(String name,
                String value)
```
    设置参数name的值 value 。
    
    Parameters:
    
    name - 参数名
    
    value - 参数值
  - setIfUnset
```
public void setIfUnset(String name,
                       String value)
```
    如果指定参数不存在则设定它
    
    Parameters:
    
    name - 参数名
    
    value - 参数值
  - get
```
public String get(String name,
                  String defaultValue)
```
    获取参数name的值，如果不存在，返回defaultValue。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的字符串值，如果不存在，返回defaultValue。
  - getInt
```
public int getInt(String name,
                  int defaultValue)
```
    获取参数name的整形值，如果不存在，返回defaultValue。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的整形值，如果不存在，返回defaultValue。
  - setInt
```
public void setInt(String name,
                   int value)
```
    设定参数 name 的整形值
    
    Parameters:
    
    name - 参数名
    
    value - 整形的参数值
  - getLong
```
public long getLong(String name,
                    long defaultValue)
```
    获取参数name的长整形值，如果不存在，返回defaultValue。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的长整型值，如果不存在，返回defaultValue。
  - setLong
```
public void setLong(String name,
                    long value)
```
    设定参数 name 的长整形值
    
    Parameters:
    
    name - 参数名
    
    value - 长整形的参数值
  - getFloat
```
public float getFloat(String name,
                      float defaultValue)
```
    获取参数name的浮点值，如果不存在，返回defaultValue。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的浮点值，如果不存在，返回defaultValue。
  - setFloat
```
public void setFloat(String name,
                     float value)
```
    设定参数 name 的浮点值
    
    Parameters:
    
    name - 参数名
    
    value - 浮点形的参数值
  - getBoolean
```
public boolean getBoolean(String name,
                          boolean defaultValue)
```
    获取参数name的布尔值，如果不存在，返回defaultValue。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的布尔值，如果不存在，返回defaultValue。
  - setBoolean
```
public void setBoolean(String name,
                       boolean value)
```
    设定参数 name 的布尔值
    
    Parameters:
    
    name - 参数名
    
    value - 布尔形的参数值
  - setBooleanIfUnset
```
public void setBooleanIfUnset(String name,
                              boolean value)
```
    如果参数 name 未设定，设定它的布尔值
    
    Parameters:
    
    name - 参数名
    
    value - 布尔形的参数值
  - getRange
```
public com.aliyun.odps.conf.Configuration.IntegerRanges getRange(String name,
                                                                 String defaultValue)
```
    获取参数name的值为一个区间，如果不存在，返回defaultValue指定的区间。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的数字区间
  - getStringCollection
```
public Collection<String> getStringCollection(String name)
```
    获取参数name的字符值集合，如果不存在，返回null。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的字符数组值，如果不存在，返回null。
  - getStrings
```
public String[] getStrings(String name)
```
    获取参数name的字符数组值，如果不存在，返回null。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的字符数组值，如果不存在，返回null。
  - getStrings
```
public String[] getStrings(String name,
                           String... defaultValue)
```
    获取参数name的字符数组值，如果不存在，返回defaultValue。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name的字符数组值，如果不存在，返回defaultValue。
  - setStrings
```
public void setStrings(String name,
                       String... values)
```
    设置参数name 的字符串数组值 value 。
    
    Parameters:
    
    name - 参数名
    
    values - 参数值
  - getClassByName
```
public Class<?> getClassByName(String name)
                        throws ClassNotFoundException
```
    根据类名载入Java类
    
    Parameters:
    
    name - 类名
    
    Returns:
    
    载入类的实例
    
    Throws:
    
    ClassNotFoundException - 如果找不到指定的Java类
  - getClasses
```
public Class<?>[] getClasses(String name,
                             Class<?>... defaultValue)
```
    获取参数name指定的类对象数组，如果不存在，返回defaultValue。如果类未能找到，则会抛出RuntimeException。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name指定的类对象数组，如果参数未指定，返回defaultValue
  - getClass
```
public Class<?> getClass(String name,
                         Class<?> defaultValue)
```
    获取参数name指定的类对象，如果不存在，返回defaultValue。如果类未能找到，则会抛出RuntimeException。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    Returns:
    
    参数name指定的类对象，如果参数未指定，返回defaultValue
  - getClass
```
public <U> Class<? extends U> getClass(String name,
                                       Class<? extends U> defaultValue,
                                       Class<U> xface)
```
    获取参数name指定的类对象，这个类实现的接口由 xface指定。如果不存在，返回defaultValue。
    
    Parameters:
    
    name - 参数名
    
    defaultValue - 默认值
    
    xface - 指定类实现的接口
    
    Returns:
    
    参数name指定的类对象, 如果参数未指定，返回 defaultValue
  - setClass
```
public void setClass(String name,
                     Class<?> theClass,
                     Class<?> xface)
```
    设置name参数指定的类，这个类实现的接口由 xface指定。
    
    Parameters:
    
    name - 参数名
    
    theClass - 参数值
    
    xface - 指定的类实现的接口
  - getFile
```
public File getFile(String dirsProp,
                    String path)
             throws IOException
```
    获取一个本地文件，其父目录由名称为 dirsProp 的参数指定，路径为 path. 如果 dirsProp 包含多个目录, 则返回其中的一个文件。如果指定的文件不存在则创建它。
    
    Parameters:
    
    dirsProp - directory in which to locate the file.
    
    path - file-path.
    
    Returns:
    
    local file under the directory with the given path.
    
    Throws:
    
    IOException
  - getResource
```
public URL getResource(String name)
```
    获取指定配置文件的URL
    
    Parameters:
    
    name - 配置文件名
    
    Returns:
    
    指定配置文件的URL
  - getConfResourceAsInputStream
```
public InputStream getConfResourceAsInputStream(String name)
```
    获取一个指定配置文件的 InputStream
    
    Parameters:
    
    name - 配置文件名
    
    Returns:
    
    指定配置文件的InputStream
  - getConfResourceAsReader
```
public Reader getConfResourceAsReader(String name)
```
    获取一个指定配置文件的 Reader
    
    Parameters:
    
    name - 配置文件名
    
    Returns:
    
    指定配置文件的Reader
  - size
```
public int size()
```
    配置项的计数
    
    Returns:
    
    配置项的计数
  - clear
```
public void clear()
```
    清除所有配置
  - iterator
```
public Iterator<Map.Entry<String,String>> iterator()
```
    所有配置的迭代器，格式为key/value。key和value的类型都为string。
    
    Specified by:
    
    iterator in interface Iterable<Map.Entry<String,String>>
    
    Returns:
    
    配置的迭代器
  - writeXml
```
public void writeXml(OutputStream out)
              throws IOException
```
    写出所有非默认的参数到一个 OutputStream
    
    Parameters:
    
    out - 输出的OutputStream
    
    Throws:
    
    IOException
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    获取ClassLoader
    
    Returns:
    
    ClassLoader对象
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    设置ClassLoader对象
    
    Parameters:
    
    classLoader - 新的ClassLoader对象
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setQuietMode
```
public void setQuietMode(boolean quietmode)
```
    设定quiet模式。quiet模式下，错误等信息不会记录在日志里。
    
    Parameters:
    
    quietmode - true 打开， false 关闭。
  - readFields
```
public void readFields(DataInput in)
                throws IOException
```
    从 DataInput 读取
    
    Specified by:
    
    readFields in interface Writable
    
    Throws:
    
    IOException
  - write
```
public void write(DataOutput out)
           throws IOException
```
    输出到 DataOutput
    
    Specified by:
    
    write in interface Writable
    
    Throws:
    
    IOException

Class Configuration

配置文件

变量引用

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Configuration

Configuration

Configuration

Method Detail

addDefaultResource

addResource

addResource

addResource

reloadConfiguration

get

getRaw

set

setIfUnset

get

getInt

setInt

getLong

setLong

getFloat

setFloat

getBoolean

setBoolean

setBooleanIfUnset

getRange

getStringCollection

getStrings

getStrings

setStrings

getClassByName

getClasses

getClass

getClass

setClass

getFile

getResource

getConfResourceAsInputStream

getConfResourceAsReader

size

clear

iterator

writeXml

getClassLoader

setClassLoader

toString

setQuietMode

readFields

write