Package org.apache.wayang.core.plugin

Class DynamicPlugin

java.lang.Object

org.apache.wayang.core.plugin.DynamicPlugin

All Implemented Interfaces:

Plugin

public class DynamicPlugin
extends java.lang.Object
implements Plugin

This Plugin can be arbitrarily customized.

Constructor Summary

Constructors

Constructor	Description
DynamicPlugin()

Method Summary

Modifier and Type	Method	Description
void	addChannelConversion(ChannelConversion channelConversion)
void	addMapping(Mapping mapping)
void	addProperty(java.lang.String key, java.lang.Object value)
void	addRequiredPlatform(Platform platform)
void	excludeChannelConversion(ChannelConversion channelConversion)
void	excludeMapping(Mapping mapping)
void	excludeRequiredPlatform(Platform platform)
java.util.Collection<ChannelConversion>	getChannelConversions()	Provides the ChannelConversions shipped with this instance.
java.util.Collection<ChannelConversion>	getExcludedChannelConversions()	Provides the ChannelConversions excluded by this instance.
java.util.Collection<Mapping>	getExcludedMappings()	Provides the Mappings excluded by this instance.
java.util.Collection<Platform>	getExcludedRequiredPlatforms()	Provides the required Platforms excluded by this instance.
java.util.Collection<Mapping>	getMappings()	Provides the Mappings shipped with this instance.
java.util.Collection<Platform>	getRequiredPlatforms()	Provides the Platforms required by this instance.
static <T> void	ifPresent(java.lang.Object o, java.lang.Class<? super T> t, java.util.function.Consumer<T> consumer)	Checks and casts the given Object.
static DynamicPlugin	loadYaml(java.lang.String yamlUrl)	Loads a YAML file of the following format:
void	setProperties(Configuration configuration)	Provides relevant Configuration properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.wayang.core.plugin.Plugin

configure

Constructor Detail

DynamicPlugin

public DynamicPlugin()

Method Detail

loadYaml

public static DynamicPlugin loadYaml(java.lang.String yamlUrl)

Loads a YAML file of the following format:

 # mappings to be loaded by this plugin
 mappings:
   include:
     - <expression that evaluates to a Mapping instance or Collection of such>
     - ...
   exclude:
     - <expression that evaluates to a Mapping instance or Collection of such>
     - ...

 # channel conversions to be loaded by this plugin
 conversions:
   include:
     - <expression that evaulates to a ChannelConversion instance or Collection of such>
     - ..
   exclude:
     - <expression that evaulates to a ChannelConversion instance or Collection of such>
     - ..

 # properties configured by this plugin
 properties:
   <property name>: <property value>

 # required platforms
 platforms:
   include:
     - <expression that evaluates to a Platform instance or Collection of such>
     - ..
   exclude:
     - <expression that evaluates to a Platform instance or Collection of such>
     - ..

 

Parameters:

yamlUrl - an URL to a YAML file of the above format

Returns:

the configured instance

See Also:

Supported expressions

ifPresent

public static <T> void ifPresent(java.lang.Object o,
                                 java.lang.Class<? super T> t,
                                 java.util.function.Consumer<T> consumer)

Checks and casts the given Object. If it is not null, feed it to a Consumer.

Parameters:

o - to be casted

t - to that should be casted

consumer - accepts the casted o unless it is null

addRequiredPlatform

public void addRequiredPlatform(Platform platform)

excludeRequiredPlatform

public void excludeRequiredPlatform(Platform platform)

getRequiredPlatforms

public java.util.Collection<Platform> getRequiredPlatforms()

Description copied from interface: Plugin

Provides the Platforms required by this instance.

Specified by:

getRequiredPlatforms in interface Plugin

Returns:

the Platforms

getExcludedRequiredPlatforms

public java.util.Collection<Platform> getExcludedRequiredPlatforms()

Description copied from interface: Plugin

Provides the required Platforms excluded by this instance.

Specified by:

getExcludedRequiredPlatforms in interface Plugin

Returns:

the Platforms

addMapping

public void addMapping(Mapping mapping)

excludeMapping

public void excludeMapping(Mapping mapping)

getMappings

public java.util.Collection<Mapping> getMappings()

Description copied from interface: Plugin

Provides the Mappings shipped with this instance.

Specified by:

getMappings in interface Plugin

Returns:

the Mappings

getExcludedMappings

public java.util.Collection<Mapping> getExcludedMappings()

Description copied from interface: Plugin

Provides the Mappings excluded by this instance.

Specified by:

getExcludedMappings in interface Plugin

Returns:

the Mappings

addChannelConversion

public void addChannelConversion(ChannelConversion channelConversion)

excludeChannelConversion

public void excludeChannelConversion(ChannelConversion channelConversion)

getChannelConversions

public java.util.Collection<ChannelConversion> getChannelConversions()

Description copied from interface: Plugin

Provides the ChannelConversions shipped with this instance.

Specified by:

getChannelConversions in interface Plugin

Returns:

the ChannelConversions

getExcludedChannelConversions

public java.util.Collection<ChannelConversion> getExcludedChannelConversions()

Description copied from interface: Plugin

Provides the ChannelConversions excluded by this instance.

Specified by:

getExcludedChannelConversions in interface Plugin

Returns:

the ChannelConversions

addProperty

public void addProperty(java.lang.String key,
                        java.lang.Object value)

setProperties

public void setProperties(Configuration configuration)

Description copied from interface: Plugin

Provides relevant Configuration properties.

Specified by:

setProperties in interface Plugin

Parameters:

configuration - accepts the properties