cascading.property
Class Props

java.lang.Object
  extended by cascading.property.Props
Direct Known Subclasses:
AggregateByProps, AppProps, CascadeProps, FlowConnectorProps, FlowProps, PartitionTapProps, SpillableProps, TrapProps, TupleEntrySchemeIteratorProps, UniqueProps

public abstract class Props
extends Object

Class Props is the base class for frameworks specific properties helper classes.

Use the sub-classes to either create a Properties instance with custom or default values to be passed to any sub-system that requires a Map or Properties instance of properties and values.

Note some Props sub-classes have static accessors. It is recommended the fluent instance methods be used instead of the static methods. All static accessors may be deprecated in future versions.


Constructor Summary
Props()
           
 
Method Summary
protected abstract  void addPropertiesTo(Properties properties)
           
 Properties buildProperties()
          Method buildProperties returns a new Properties instance with all property values for this type.
 Properties buildProperties(Iterable<Map.Entry<String,String>> defaultProperties)
          Method buildProperties returns a new Properties instance with all property values for this type using the given Iterable> of property values as defaults.
 Properties buildProperties(Map<Object,Object> defaultProperties)
          Method buildProperties returns a new Properties instance with all property values for this type using the given Map of property values as defaults.
 Properties buildProperties(Properties defaultProperties)
          Method buildProperties returns a new Properties instance with all property values for this type using the given Properties instance of property values as defaults.
 ConfigDef setProperties(ConfigDef configDef)
           
 ConfigDef setProperties(ConfigDef configDef, ConfigDef.Mode mode)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Props

public Props()
Method Detail

buildProperties

public Properties buildProperties()
Method buildProperties returns a new Properties instance with all property values for this type.

If no values have been set, all default properties and values will be returned.

Returns:
a new Properties instance

buildProperties

public Properties buildProperties(Map<Object,Object> defaultProperties)
Method buildProperties returns a new Properties instance with all property values for this type using the given Map of property values as defaults. The given Map will not be modified.

If no values have been set, all default properties and values will be returned.

Returns:
a new Properties instance

buildProperties

public Properties buildProperties(Iterable<Map.Entry<String,String>> defaultProperties)
Method buildProperties returns a new Properties instance with all property values for this type using the given Iterable> of property values as defaults. The given Iterable will not be modified.

If no values have been set, all default properties and values will be returned.

Returns:
a new Properties instance

buildProperties

public Properties buildProperties(Properties defaultProperties)
Method buildProperties returns a new Properties instance with all property values for this type using the given Properties instance of property values as defaults. The given Map will not be modified.

If no values have been set, all default properties and values will be returned.

Returns:
a new Properties instance

setProperties

public ConfigDef setProperties(ConfigDef configDef)

setProperties

public ConfigDef setProperties(ConfigDef configDef,
                               ConfigDef.Mode mode)

addPropertiesTo

protected abstract void addPropertiesTo(Properties properties)


Copyright © 2007-2015 Concurrent, Inc. All Rights Reserved.