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
@Deprecated(since="1818",
forRemoval=true)
public abstract class AbstractResourceWriter
extends ClassWriter
Deprecated, for removal: This API element is subject to removal in a future version.
since 1818
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
FieldsModifier and TypeFieldDescriptionprotected static final StringDeprecated, for removal: This API element is subject to removal in a future version.protected static final StringDeprecated, for removal: This API element is subject to removal in a future version.protected static final StringDeprecated, for removal: This API element is subject to removal in a future version.protected static final StringDeprecated, for removal: This API element is subject to removal in a future version.static final StringDeprecated, for removal: This API element is subject to removal in a future version.static final StringDeprecated, for removal: This API element is subject to removal in a future version.protected static final StringDeprecated, for removal: This API element is subject to removal in a future version.protected static final StringDeprecated, for removal: This API element is subject to removal in a future version.protected static final StringDeprecated, for removal: This API element is subject to removal in a future version.Fields inherited from class de.hybris.bootstrap.codegenerator.ClassWriter
GENERATED_NOTICE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractResourceWriter(ResourceConfig cfg, CodeGenerator gen, YExtension ext) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionprotected MethodWritercreateCRUDMethodWriter(String ano, String methodName) Deprecated, for removal: This API element is subject to removal in a future version.Creates a CRUDMethodWritertemplate.protected MethodWriterDeprecated, for removal: This API element is subject to removal in a future version.protected abstract MethodWriterDeprecated, for removal: This API element is subject to removal in a future version.protected abstract MethodWriterDeprecated, for removal: This API element is subject to removal in a future version.protected abstract MethodWriterDeprecated, for removal: This API element is subject to removal in a future version.protected abstract MethodWriterDeprecated, for removal: This API element is subject to removal in a future version.protected MethodWritercreateReadResourceMethodWriter(String returnClassType) Deprecated, for removal: This API element is subject to removal in a future version.protected Collection<MethodWriter>createResourceValueMethodWriters(String valueType, String genericType, String name) Deprecated, for removal: This API element is subject to removal in a future version.protected MethodWritercreateSubResourceMethodWriter(ResourceConfig subResourceCfg, boolean isSingleResource) Deprecated, for removal: This API element is subject to removal in a future version.protected voidfill()Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Returns the simple class name of the resource which shall be generated.protected Collection<MethodWriter>Deprecated, for removal: This API element is subject to removal in a future version.Returns the Constructor asMethodWriter.protected Collection<MethodWriter>Deprecated, for removal: This API element is subject to removal in a future version.Returns supported CRUD operations asMethodWriterCollectionprotected Collection<MethodWriter>Deprecated, for removal: This API element is subject to removal in a future version.protected abstract MethodWriterDeprecated, for removal: This API element is subject to removal in a future version.Returns the 'readResource'MethodWriter.protected ResourceConfigDeprecated, for removal: This API element is subject to removal in a future version.Returns theResourceConfigwhich is used for specific generation information.protected abstract Collection<MethodWriter>Deprecated, for removal: This API element is subject to removal in a future version.Convenience Getter/SetterMethodWriterwhich delegates to AbstractResource#get/setResourceValue(...) but is named more user-friendly.protected abstract Collection<MethodWriter>Deprecated, for removal: This API element is subject to removal in a future version.Returns supported sub-resources asMethodWriterCollectionMethods inherited from class de.hybris.bootstrap.codegenerator.ClassWriter
addAnnotation, addAnnotationIfDeprecated, addAnnotations, addConstantDeclaration, addConstantDeclaration, addConstructor, addDeclaration, addDeclaration, addDeclaration, addInterface, addMethod, assembleAbstractClassName, assembleClassName, containsAnnotation, firstLetterUpperCase, getAnnotations, getClassToExtend, getConstantDeclarations, getConstructors, getCopyright, getDeclarations, getExtension, getGenerator, getInfo, getInterfaces, getJavadoc, getMethods, getModifiers, getPackageName, getRequiredImports, getVisibility, isGeneratePartOf, processAnnotations, removeSelfImport, setClassToExtend, setCopyright, setJavadoc, setModifiers, setPackageName, setVisibility, sortMethods, write, writeMethods, writeSignatureMethods inherited from class de.hybris.bootstrap.codegenerator.AbstractImportProvider
addRequiredImport
-
Field Details
-
WS_GET
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
WS_PUT
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
WS_POST
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
WS_DELETE
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
WS_RESPONSE
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
WS_PATH
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
WS_PATHPARAM
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
ABSTRACT_YRESOURCE
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
READRESOURCE_METHOD
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
-
-
Constructor Details
-
AbstractResourceWriter
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
getClassName
Deprecated, for removal: This API element is subject to removal in a future version.Returns the simple class name of the resource which shall be generated.- Overrides:
getClassNamein classClassWriter- Returns:
- resource class name
- See Also:
-
getResourceConfig
Deprecated, for removal: This API element is subject to removal in a future version.Returns theResourceConfigwhich is used for specific generation information.- Returns:
ResourceConfig
-
fill
protected void fill()Deprecated, for removal: This API element is subject to removal in a future version.- Overrides:
fillin classClassWriter
-
getConstructorMethodWriters
Deprecated, for removal: This API element is subject to removal in a future version.Returns the Constructor asMethodWriter. Default implementation is default constructor.- Returns:
MethodWriter
-
getCRUDMethodWriters
Deprecated, for removal: This API element is subject to removal in a future version.Returns supported CRUD operations asMethodWriterCollection- Returns:
- Collection of
MethodWriter
-
getSubResourceMethodWriters
Deprecated, for removal: This API element is subject to removal in a future version.Returns supported sub-resources asMethodWriterCollection- Returns:
- Collection of
MethodWriter
-
getReadResourceMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version.Returns the 'readResource'MethodWriter.- Returns:
MethodWriter
-
getResourceValueMethodWriters
Deprecated, for removal: This API element is subject to removal in a future version.Convenience Getter/SetterMethodWriterwhich delegates to AbstractResource#get/setResourceValue(...) but is named more user-friendly.- Returns:
- Getter/Setter
MethodWriter
-
getCustomMethodWriters
Deprecated, for removal: This API element is subject to removal in a future version. -
createDefaultConstructorMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version. -
createGetMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version. -
createDeleteMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version. -
createPutMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version. -
createPostMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version. -
createResourceValueMethodWriters
protected Collection<MethodWriter> createResourceValueMethodWriters(String valueType, String genericType, String name) Deprecated, for removal: This API element is subject to removal in a future version. -
createCRUDMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version.Creates a CRUDMethodWritertemplate.- Parameters:
ano- CRUD operation as annotation namemethodName- CRUD method name- Returns:
MethodWriter
-
createReadResourceMethodWriter
Deprecated, for removal: This API element is subject to removal in a future version. -
createSubResourceMethodWriter
protected MethodWriter createSubResourceMethodWriter(ResourceConfig subResourceCfg, boolean isSingleResource) Deprecated, for removal: This API element is subject to removal in a future version.
-