org.apache.nifi.controller.serialization

Class FlowEncodingVersion

java.lang.Object

org.apache.nifi.controller.serialization.FlowEncodingVersion

public class FlowEncodingVersion
extends java.lang.Object

Provides a mechanism for interpreting the version of the encoding scheme that was used to serialize a NiFi Flow. The versioning scheme is made up of a major version and a minor version, both being positive integers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENCODING_VERSION_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
FlowEncodingVersion(int majorVersion, int minorVersion)

Method Summary

Modifier and Type	Method and Description
int	getMajorVersion()
int	getMinorVersion()
static FlowEncodingVersion	parse(org.w3c.dom.Element xmlElement) Parses the 'encoding-version' attribute of the given XML Element as FlowEncodingVersion.
static FlowEncodingVersion	parse(java.lang.String version) Parses the given String as FlowEncodingVersion.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING_VERSION_ATTRIBUTE

public static final java.lang.String ENCODING_VERSION_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

FlowEncodingVersion

public FlowEncodingVersion(int majorVersion,
                           int minorVersion)

Method Detail

parse

public static FlowEncodingVersion parse(org.w3c.dom.Element xmlElement)

Parses the 'encoding-version' attribute of the given XML Element as FlowEncodingVersion. The attribute value is expected to be in the format <major version>.<minor version<

Parameters:

xmlElement - the XML Element that contains an 'encoding-version' attribute

Returns:

a FlowEncodingVersion that has the major and minor versions specified in the String, or null if the input is null or the input does not have an 'encoding-version' attribute

Throws:

java.lang.IllegalArgumentException - if the value is not in the format <major version>.<minor version>, if either major version or minor version is not an integer, or if either the major or minor version is less than 0.

parse

public static FlowEncodingVersion parse(java.lang.String version)

Parses the given String as FlowEncodingVersion. The String is expected to be in the format <major version>.<minor version<

Parameters:

version - the String representation of the encoding version

Returns:

a FlowEncodingVersion that has the major and minor versions specified in the String, or null if the input is null

Throws:

java.lang.IllegalArgumentException - if the value is not in the format <major version>.<minor version>, if either major version or minor version is not an integer, or if either the major or minor version is less than 0.

getMajorVersion

public int getMajorVersion()

getMinorVersion

public int getMinorVersion()