Package de.hybris.bootstrap.codegenerator.platformwebservices.resource

Class 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 Detail

      • WS_GET

        protected static final java.lang.String WS_GET
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • WS_PUT

        protected static final java.lang.String WS_PUT
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • WS_POST

        protected static final java.lang.String WS_POST
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • WS_DELETE

        protected static final java.lang.String WS_DELETE
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • WS_RESPONSE

        protected static final java.lang.String WS_RESPONSE
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • WS_PATH

        public static final java.lang.String WS_PATH
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • WS_PATHPARAM

        public static final java.lang.String WS_PATHPARAM
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • ABSTRACT_YRESOURCE

        protected static final java.lang.String ABSTRACT_YRESOURCE
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

      • READRESOURCE_METHOD

        protected static final java.lang.String READRESOURCE_METHOD
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractResourceWriter

        protected AbstractResourceWriter​(ResourceConfig cfg,
                                 CodeGenerator gen,
                                 YExtension ext)
        Deprecated, for removal: This API element is subject to removal in a future version.

    • Method Detail

      • getClassName

        public java.lang.String 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:
        getClassName in class ClassWriter
        Returns:
        resource class name
        See Also:
        ClassWriter.getClassName()

      • getResourceConfig

        protected ResourceConfig getResourceConfig()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the ResourceConfig which 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:
        fill in class ClassWriter

      • getConstructorMethodWriters

        protected java.util.Collection<MethodWriter> getConstructorMethodWriters()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the Constructor as MethodWriter. Default implementation is default constructor.
        Returns:
        MethodWriter

      • getCRUDMethodWriters

        protected java.util.Collection<MethodWriter> getCRUDMethodWriters()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns supported CRUD operations as MethodWriter Collection
        Returns:
        Collection of MethodWriter

      • getSubResourceMethodWriters

        protected abstract java.util.Collection<MethodWriter> getSubResourceMethodWriters()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns supported sub-resources as MethodWriter Collection
        Returns:
        Collection of MethodWriter

      • getReadResourceMethodWriter

        protected abstract MethodWriter getReadResourceMethodWriter()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the 'readResource' MethodWriter.
        Returns:
        MethodWriter

      • getResourceValueMethodWriters

        protected abstract java.util.Collection<MethodWriter> getResourceValueMethodWriters()
        Deprecated, for removal: This API element is subject to removal in a future version.
        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()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • createDefaultConstructorMethodWriter

        protected MethodWriter createDefaultConstructorMethodWriter()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • createGetMethodWriter

        protected abstract MethodWriter createGetMethodWriter()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • createDeleteMethodWriter

        protected abstract MethodWriter createDeleteMethodWriter()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • createPutMethodWriter

        protected abstract MethodWriter createPutMethodWriter()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • createPostMethodWriter

        protected abstract MethodWriter createPostMethodWriter()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • createResourceValueMethodWriters

        protected java.util.Collection<MethodWriter> createResourceValueMethodWriters​(java.lang.String valueType,
                                                                              java.lang.String genericType,
                                                                              java.lang.String name)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • createCRUDMethodWriter

        protected MethodWriter createCRUDMethodWriter​(java.lang.String ano,
                                              java.lang.String methodName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        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)
        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.