de.hybris.bootstrap.codegenerator.platformwebservices.resource

Class AbstractResourceWriter

java.lang.Object

de.hybris.bootstrap.codegenerator.AbstractImportProvider

de.hybris.bootstrap.codegenerator.ClassWriter

de.hybris.bootstrap.codegenerator.platformwebservices.resource.AbstractResourceWriter

All Implemented Interfaces:

CodeWriter

Direct Known Subclasses:

CollectionResourceWriter, SingleResourceWriter

public abstract class AbstractResourceWriter
extends ClassWriter

Abstract ClassWriter which covers general resource specific operations.

A resource class must provide some typical properties/methods which are specified by this abstract class. These are in particular:

• constructor without any parameter
• readResource method
• CRUD methods; with GET, PUT, POST, DELETE annotated methods
• subresource locators, a Collection of methods which are returning possible subresources

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ABSTRACT_YRESOURCE
protected static java.lang.String	READRESOURCE_METHOD
protected static java.lang.String	WS_DELETE
protected static java.lang.String	WS_GET
static java.lang.String	WS_PATH
static java.lang.String	WS_PATHPARAM
protected static java.lang.String	WS_POST
protected static java.lang.String	WS_PUT
protected static java.lang.String	WS_RESPONSE

Fields inherited from class de.hybris.bootstrap.codegenerator.ClassWriter

GENERATED_NOTICE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResourceWriter(ResourceConfig cfg, CodeGenerator gen, YExtension ext)

Method Summary

Modifier and Type	Method and Description
protected MethodWriter	createCRUDMethodWriter(java.lang.String ano, java.lang.String methodName) Creates a CRUD MethodWriter template.
protected MethodWriter	createDefaultConstructorMethodWriter()
protected abstract MethodWriter	createDeleteMethodWriter()
protected abstract MethodWriter	createGetMethodWriter()
protected abstract MethodWriter	createPostMethodWriter()
protected abstract MethodWriter	createPutMethodWriter()
protected MethodWriter	createReadResourceMethodWriter(java.lang.String returnClassType)
protected java.util.Collection<MethodWriter>	createResourceValueMethodWriters(java.lang.String valueType, java.lang.String genericType, java.lang.String name)
protected MethodWriter	createSubResourceMethodWriter(ResourceConfig subResourceCfg, boolean isSingleResource)
protected void	fill()
java.lang.String	getClassName() Returns the simple class name of the resource which shall be generated.
protected java.util.Collection<MethodWriter>	getConstructorMethodWriters() Returns the Constructor as MethodWriter.
protected java.util.Collection<MethodWriter>	getCRUDMethodWriters() Returns supported CRUD operations as MethodWriter Collection
protected java.util.Collection<MethodWriter>	getCustomMethodWriters()
protected abstract MethodWriter	getReadResourceMethodWriter() Returns the 'readResource' MethodWriter.
protected ResourceConfig	getResourceConfig() Returns the ResourceConfig which is used for specific generation information.
protected abstract java.util.Collection<MethodWriter>	getResourceValueMethodWriters() Convenience Getter/Setter MethodWriter which delegates to AbstractResource#get/setResourceValue(...) but is named more user-friendly.
protected abstract java.util.Collection<MethodWriter>	getSubResourceMethodWriters() Returns supported sub-resources as MethodWriter Collection

Methods inherited from class de.hybris.bootstrap.codegenerator.ClassWriter

addAnnotation, addAnnotations, addConstantDeclaration, addConstantDeclaration, addConstructor, addDeclaration, addDeclaration, addDeclaration, addInterface, addMethod, assembleAbstractClassName, assembleClassName, containsAnnotation, disableSuppressPMD, firstLetterUpperCase, getAnnotations, getClassToExtend, getConstantDeclarations, getConstructors, getCopyright, getDeclarations, getExtension, getGenerator, getInfo, getInterfaces, getJavadoc, getMethods, getModifiers, getPackageName, getRequiredImports, getVisibility, isGeneratePartOf, isSuppressPMD, processAnnotations, removeSelfImport, setClassToExtend, setCopyright, setJavadoc, setModifiers, setPackageName, setVisibility, sortMethods, write, writeMethods, writeSignature

Methods inherited from class de.hybris.bootstrap.codegenerator.AbstractImportProvider

addRequiredImport

Methods inherited from class java.lang.Object

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

Field Detail

WS_GET

protected static final java.lang.String WS_GET

See Also:

Constant Field Values

WS_PUT

protected static final java.lang.String WS_PUT

See Also:

Constant Field Values

WS_POST

protected static final java.lang.String WS_POST

See Also:

Constant Field Values

WS_DELETE

protected static final java.lang.String WS_DELETE

See Also:

Constant Field Values

WS_RESPONSE

protected static final java.lang.String WS_RESPONSE

See Also:

Constant Field Values

WS_PATH

public static final java.lang.String WS_PATH

See Also:

Constant Field Values

WS_PATHPARAM

public static final java.lang.String WS_PATHPARAM

See Also:

Constant Field Values

ABSTRACT_YRESOURCE

protected static final java.lang.String ABSTRACT_YRESOURCE

See Also:

Constant Field Values

READRESOURCE_METHOD

protected static final java.lang.String READRESOURCE_METHOD

See Also:

Constant Field Values

Constructor Detail

AbstractResourceWriter

protected AbstractResourceWriter(ResourceConfig cfg,
                                 CodeGenerator gen,
                                 YExtension ext)

Method Detail

getClassName

public java.lang.String getClassName()

Returns the simple class name of the resource which shall be generated.

Overrides:

getClassName in class ClassWriter

Returns:

resource class name

See Also:

ClassWriter.getClassName()

getResourceConfig

protected ResourceConfig getResourceConfig()

Returns the ResourceConfig which is used for specific generation information.

Returns:

ResourceConfig

fill

protected void fill()

Overrides:

fill in class ClassWriter

getConstructorMethodWriters

protected java.util.Collection<MethodWriter> getConstructorMethodWriters()

Returns the Constructor as MethodWriter. Default implementation is default constructor.

Returns:

MethodWriter

getCRUDMethodWriters

protected java.util.Collection<MethodWriter> getCRUDMethodWriters()

Returns supported CRUD operations as MethodWriter Collection

Returns:

Collection of MethodWriter

getSubResourceMethodWriters

protected abstract java.util.Collection<MethodWriter> getSubResourceMethodWriters()

Returns supported sub-resources as MethodWriter Collection

Returns:

Collection of MethodWriter

getReadResourceMethodWriter

protected abstract MethodWriter getReadResourceMethodWriter()

Returns the 'readResource' MethodWriter.

Returns:

MethodWriter

getResourceValueMethodWriters

protected abstract java.util.Collection<MethodWriter> getResourceValueMethodWriters()

Convenience Getter/Setter MethodWriter which delegates to AbstractResource#get/setResourceValue(...) but is named more user-friendly.

Returns:

Getter/Setter MethodWriter

getCustomMethodWriters

protected java.util.Collection<MethodWriter> getCustomMethodWriters()

createDefaultConstructorMethodWriter

protected MethodWriter createDefaultConstructorMethodWriter()

createGetMethodWriter

protected abstract MethodWriter createGetMethodWriter()

createDeleteMethodWriter

protected abstract MethodWriter createDeleteMethodWriter()

createPutMethodWriter

protected abstract MethodWriter createPutMethodWriter()

createPostMethodWriter

protected abstract MethodWriter createPostMethodWriter()

createResourceValueMethodWriters

protected java.util.Collection<MethodWriter> createResourceValueMethodWriters(java.lang.String valueType,
                                                                              java.lang.String genericType,
                                                                              java.lang.String name)

createCRUDMethodWriter

protected MethodWriter createCRUDMethodWriter(java.lang.String ano,
                                              java.lang.String methodName)

Creates a CRUD MethodWriter template.

Parameters:

ano - CRUD operation as annotation name

methodName - CRUD method name

Returns:

MethodWriter

createReadResourceMethodWriter

protected MethodWriter createReadResourceMethodWriter(java.lang.String returnClassType)

createSubResourceMethodWriter

protected MethodWriter createSubResourceMethodWriter(ResourceConfig subResourceCfg,
                                                     boolean isSingleResource)