com.mulesoft.jaxrs.raml.annotation.model

Class ResourceVisitor

java.lang.Object

com.mulesoft.jaxrs.raml.annotation.model.ResourceVisitor

Direct Known Subclasses:

RuntimeResourceVisitor

public abstract class ResourceVisitor
extends Object

Abstract ResourceVisitor class.

Version:

$Id: $Id

Author:

kor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ResourceVisitor.CustomSchemaOutputResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	classConsumes
protected ClassLoader	classLoader
protected String[]	classProduces
protected HashSet<ITypeModel>	consumedTypes
protected static String	EXAMPLES_FOLDER Constant EXAMPLES_FOLDER="examples"
protected File	outputFile
protected JAXBRegistry	regsistry
protected static String	SCHEMAS_FOLDER Constant SCHEMAS_FOLDER="schemas"
protected RAMLModelHelper	spec
protected static String	XML_FILE_EXT Constant XML_FILE_EXT=".xml"

Constructor Summary

Constructors

Constructor and Description
ResourceVisitor(File outputFile, ClassLoader classLoader) Constructor for ResourceVisitor.

Method Summary

Modifier and Type	Method and Description
protected void	afterSchemaGen(ITypeModel t, StructureType st) afterSchemaGen.
void	clear() clear.
protected File	constructFileLocation(String name, String fileType, String mediaType, StructureType st)
protected String	constructFileName(String name, String fileType, String mediaType, StructureType st)
protected String	constructRelativeFilePath(String name, String fileType, String mediaType, StructureType st)
protected abstract ResourceVisitor	createResourceVisitor() createResourceVisitor.
protected void	doGenerateAndSave(File schemaFile, File parentDir, File examplesDir, String dummyXml) doGenerateAndSave.
protected void	generateExamle(File schemaFile, String content) generateExamle.
protected String	generateXMLExampleJAXB(ITypeModel t) generateXMLExampleJAXB.
protected boolean	generateXMLSchema(ITypeModel t, StructureType st) generateXMLSchema.
protected String	generateXSDForClass(Class<?> element) generateXSDForClass.
String	getRaml() getRaml.
boolean	isEmpty() isEmpty.
void	setPreferences(IRamlConfig preferencesConfig) setPreferences.
void	visit(ITypeModel t) visit.
protected void	writeString(String str, File toSave) writeString.

Methods inherited from class java.lang.Object

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

Field Detail

XML_FILE_EXT

protected static final String XML_FILE_EXT

Constant XML_FILE_EXT=".xml"

See Also:

Constant Field Values

SCHEMAS_FOLDER

protected static final String SCHEMAS_FOLDER

Constant SCHEMAS_FOLDER="schemas"

See Also:

Constant Field Values

EXAMPLES_FOLDER

protected static final String EXAMPLES_FOLDER

Constant EXAMPLES_FOLDER="examples"

See Also:

Constant Field Values

regsistry

protected JAXBRegistry regsistry

spec

protected RAMLModelHelper spec

classConsumes

protected String[] classConsumes

classProduces

protected String[] classProduces

consumedTypes

protected HashSet<ITypeModel> consumedTypes

outputFile

protected final File outputFile

classLoader

protected final ClassLoader classLoader

Constructor Detail

ResourceVisitor

public ResourceVisitor(File outputFile,
                       ClassLoader classLoader)

Constructor for ResourceVisitor.

Parameters:

outputFile - a File object.

classLoader - a ClassLoader object.

Method Detail

visit

public void visit(ITypeModel t)

visit.

Parameters:

t - a ITypeModel object.

generateXMLSchema

protected boolean generateXMLSchema(ITypeModel t,
                                    StructureType st)

generateXMLSchema.

Parameters:

t - a ITypeModel object.

st - a StructureType object.

Returns:

if schema is correctly generated and can be used inside RAML

generateXMLExampleJAXB

protected String generateXMLExampleJAXB(ITypeModel t)

generateXMLExampleJAXB.

Parameters:

t - a ITypeModel object.

Returns:

a String object.

getRaml

public String getRaml()

getRaml.

Returns:

a String object.

createResourceVisitor

protected abstract ResourceVisitor createResourceVisitor()

createResourceVisitor.

Returns:

a ResourceVisitor object.

generateXSDForClass

protected String generateXSDForClass(Class<?> element)

generateXSDForClass.

Parameters:

element - a Class object.

Returns:

XSD schema for input class

constructFileLocation

protected File constructFileLocation(String name,
                                     String fileType,
                                     String mediaType,
                                     StructureType st)

constructRelativeFilePath

protected String constructRelativeFilePath(String name,
                                           String fileType,
                                           String mediaType,
                                           StructureType st)

constructFileName

protected String constructFileName(String name,
                                   String fileType,
                                   String mediaType,
                                   StructureType st)

clear

public void clear()

clear.

isEmpty

public boolean isEmpty()

isEmpty.

Returns:

a boolean.

doGenerateAndSave

protected void doGenerateAndSave(File schemaFile,
                                 File parentDir,
                                 File examplesDir,
                                 String dummyXml)

doGenerateAndSave.

Parameters:

schemaFile - a File object.

parentDir - a File object.

examplesDir - a File object.

dummyXml - a String object.

writeString

protected void writeString(String str,
                           File toSave)

writeString.

Parameters:

str - a String object.

toSave - a File object.

generateExamle

protected void generateExamle(File schemaFile,
                              String content)

generateExamle.

Parameters:

schemaFile - a File object.

content - a String object.

setPreferences

public void setPreferences(IRamlConfig preferencesConfig)

setPreferences.

Parameters:

preferencesConfig - a IRamlConfig object.

afterSchemaGen

protected void afterSchemaGen(ITypeModel t,
                              StructureType st)

afterSchemaGen.

Parameters:

t - a ITypeModel object.

st - a StructureType object.