org.overlord.sramp.common

Class ArtifactType

java.lang.Object

org.overlord.sramp.common.ArtifactType

public class ArtifactType
extends Object

A class representing all of the Artifact Types defined by S-RAMP.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
static ArtifactType	Document()
static ArtifactType	Document(String mimeType)
boolean	equals(Object obj)
static ArtifactType	ExtendedArtifactType(String extendedType, boolean derived)
static ArtifactType	ExtendedDocument(String extendedType)
static ArtifactType	fromFileExtension(String extension) Deprecated.
ArtifactTypeEnum	getArtifactType()
String	getExtendedType()
String	getLabel()
String	getMimeType()
String	getModel()
String	getType()
int	hashCode()
boolean	isDerived()
protected boolean	isExtendedDerivedType()
boolean	isExtendedType()
org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType	newArtifactInstance() Instantiates an S-RAMP artifact of the correct type, and populates the artifactType and the contentType.
static ArtifactType	PolicyDocument()
void	setArtifactType(ArtifactTypeEnum artifactType)
void	setExtendedDerivedType(boolean extendedDerivedType)
void	setExtendedType(String extendedType)
void	setMimeType(String mimeType)
String	toString()
org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType	unwrap(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Artifact artifactWrapper) Called to unwrap the S-RAMP artifact from its wrapper.
static ArtifactType	valueOf(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Artifact artifactWrapper, String hint) What kind of artifact is inside that wrapper?
static ArtifactType	valueOf(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactEnum apiType) Figures out the type from the s-ramp API type.
static ArtifactType	valueOf(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact) Figures out the type from the artifact instance.
static ArtifactType	valueOf(String artifactType) Figures out the artifact type (enum) from the given S-RAMP artifact type string.
static ArtifactType	valueOf(String model, String type, Boolean isDocument) Determines the ArtifactType from the model and type.
static ArtifactType	WsdlDocument()
static ArtifactType	XmlDocument()
static ArtifactType	XsdDocument()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

Document

public static final ArtifactType Document()

Document

public static final ArtifactType Document(String mimeType)

XmlDocument

public static final ArtifactType XmlDocument()

XsdDocument

public static final ArtifactType XsdDocument()

WsdlDocument

public static final ArtifactType WsdlDocument()

PolicyDocument

public static final ArtifactType PolicyDocument()

ExtendedArtifactType

public static final ArtifactType ExtendedArtifactType(String extendedType,
                                boolean derived)

ExtendedDocument

public static final ArtifactType ExtendedDocument(String extendedType)

unwrap

public org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType unwrap(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Artifact artifactWrapper)

Called to unwrap the S-RAMP artifact from its wrapper.

Parameters:

artifactWrapper - the S-RAMP artifact wrapper

Returns:

the specific artifact based on type

fromFileExtension

public static ArtifactType fromFileExtension(String extension)

Deprecated.

Returns an ArtifactType given a common file extension.

Parameters:

extension - a file extension

Returns:

an s-ramp artifact type

valueOf

public static ArtifactType valueOf(String artifactType)

Figures out the artifact type (enum) from the given S-RAMP artifact type string.

Parameters:

artifactType -

valueOf

public static ArtifactType valueOf(String model,
                   String type,
                   Boolean isDocument)

Determines the ArtifactType from the model and type. If the model is "ext" (extended) then the artifactType can be either ExtendedArtifactType or ExtendedDocument. All extended artifacts that have contend inherit from ExtendedDocument.

Parameters:

model - - the model, for example core, xsd, wsdl, ext, etc.

type - - the type, for example XmlDocument, WsdlDocument

isDocument - - this flag is taken into account ONLY when the model is 'ext', in this case the 'type' can be ExtendedDocument, ExtendedArtifactType, or a user defined value (for example 'SwitchYardApplication'). The flag 'isDocument' is required only if the type is user defined so it can distinguish between an artifact with (true) or without (false) content. If this is not known at the time of calling a value of null can be given which will default the ArtifactType of ExtendedArtifactType.

Returns:

ArtifactType

valueOf

public static ArtifactType valueOf(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact)

Figures out the type from the artifact instance.

Parameters:

artifact -

newArtifactInstance

public org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType newArtifactInstance()

Instantiates an S-RAMP artifact of the correct type, and populates the artifactType and the contentType.

Parameters:

artifactType -

valueOf

public static ArtifactType valueOf(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactEnum apiType)

Figures out the type from the s-ramp API type.

Parameters:

apiType -

getArtifactType

public ArtifactTypeEnum getArtifactType()

Returns:

the artifactType

isExtendedType

public boolean isExtendedType()

Returns:

true if the type is a ExtendedArtifactType.

isDerived

public boolean isDerived()

Returns:

true if the artifact is derived

setArtifactType

public void setArtifactType(ArtifactTypeEnum artifactType)

Parameters:

artifactType - the artifactType to set

getModel

public String getModel()

Returns:

the artifact model

getType

public String getType()

Returns:

the artifact type

getLabel

public String getLabel()

Returns:

the artifact type label

getMimeType

public String getMimeType()

Returns:

the mimeType

setMimeType

public void setMimeType(String mimeType)

Parameters:

mimeType - the mimeType to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

setExtendedType

public void setExtendedType(String extendedType)

getExtendedType

public String getExtendedType()

valueOf

public static ArtifactType valueOf(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Artifact artifactWrapper,
                   String hint)

What kind of artifact is inside that wrapper?

Parameters:

artifactWrapper -

isExtendedDerivedType

protected boolean isExtendedDerivedType()

Returns:

the extendedDerivedType

setExtendedDerivedType

public void setExtendedDerivedType(boolean extendedDerivedType)

Parameters:

extendedDerivedType - the extendedDerivedType to set

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)