com.dtolabs.rundeck.core.resources.format

Class ResourceYamlFormatParser

java.lang.Object

com.dtolabs.rundeck.core.resources.format.ResourceYamlFormatParser

All Implemented Interfaces:

Describable, ResourceFormatParser

public class ResourceYamlFormatParser
extends java.lang.Object
implements ResourceFormatParser, Describable

ResourcesYamlFormatParser is ...

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<java.lang.String>	EXTENSIONS
static java.util.Set<java.lang.String>	MIME_TYPES
static java.lang.String	SERVICE_PROVIDER_TYPE

Constructor Summary

Constructors

Constructor and Description
ResourceYamlFormatParser()

Method Summary

Modifier and Type	Method and Description
Description	getDescription()
java.util.Set<java.lang.String>	getFileExtensions()
java.util.Set<java.lang.String>	getMIMETypes()
java.lang.String	getPreferredFileExtension()
java.lang.String	getPreferredMimeType()
INodeSet	parseDocument(java.io.File file) Parse a file
INodeSet	parseDocument(java.io.InputStream input) Parse an input stream

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_PROVIDER_TYPE

public static final java.lang.String SERVICE_PROVIDER_TYPE

See Also:

Constant Field Values

EXTENSIONS

public static final java.util.Set<java.lang.String> EXTENSIONS

MIME_TYPES

public static final java.util.Set<java.lang.String> MIME_TYPES

Constructor Detail

ResourceYamlFormatParser

public ResourceYamlFormatParser()

Method Detail

getFileExtensions

public java.util.Set<java.lang.String> getFileExtensions()

Specified by:

getFileExtensions in interface ResourceFormatParser

Returns:

the list of file extensions that this format parser can parse.

getPreferredFileExtension

public java.lang.String getPreferredFileExtension()

Specified by:

getPreferredFileExtension in interface ResourceFormatParser

Returns:

the single preferred file extension, or null

getMIMETypes

public java.util.Set<java.lang.String> getMIMETypes()

Specified by:

getMIMETypes in interface ResourceFormatParser

Returns:

the list of MIME types that this format parser can parse. This may include wildcards such as "*/xml".

getPreferredMimeType

public java.lang.String getPreferredMimeType()

Specified by:

getPreferredMimeType in interface ResourceFormatParser

Returns:

the single preferred mime type, or null

parseDocument

public INodeSet parseDocument(java.io.File file)
                       throws ResourceFormatParserException

Description copied from interface: ResourceFormatParser

Parse a file

Specified by:

parseDocument in interface ResourceFormatParser

Parameters:

file - input file

Returns:

nodes

Throws:

ResourceFormatParserException - on parse error

parseDocument

public INodeSet parseDocument(java.io.InputStream input)
                       throws ResourceFormatParserException

Description copied from interface: ResourceFormatParser

Parse an input stream

Specified by:

parseDocument in interface ResourceFormatParser

Parameters:

input - input stream

Returns:

nodes

Throws:

ResourceFormatParserException - on parse error

getDescription

public Description getDescription()

Specified by:

getDescription in interface Describable

Returns:

the configuration description