Class OpenAPIImpl

  • All Implemented Interfaces:
    Cloneable, org.eclipse.microprofile.openapi.models.Constructible, org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.OpenAPI>, org.eclipse.microprofile.openapi.models.OpenAPI

    public class OpenAPIImpl
    extends ExtensibleImpl<org.eclipse.microprofile.openapi.models.OpenAPI>
    implements org.eclipse.microprofile.openapi.models.OpenAPI, Cloneable
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.eclipse.microprofile.openapi.models.Components components  
      protected Map<String,​Set<String>> endpoints  
      protected org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs  
      protected org.eclipse.microprofile.openapi.models.info.Info info  
      protected String openapi  
      protected org.eclipse.microprofile.openapi.models.Paths paths  
      protected List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security  
      protected List<org.eclipse.microprofile.openapi.models.servers.Server> servers  
      protected List<org.eclipse.microprofile.openapi.models.tags.Tag> tags  
    • Constructor Summary

      Constructors 
      Constructor Description
      OpenAPIImpl()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.eclipse.microprofile.openapi.models.OpenAPI addSecurityRequirement​(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)  
      org.eclipse.microprofile.openapi.models.OpenAPI addServer​(org.eclipse.microprofile.openapi.models.servers.Server server)  
      org.eclipse.microprofile.openapi.models.OpenAPI addTag​(org.eclipse.microprofile.openapi.models.tags.Tag tag)  
      org.eclipse.microprofile.openapi.models.OpenAPI clone()  
      static org.eclipse.microprofile.openapi.models.OpenAPI createInstance​(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation, ApiContext context)  
      org.eclipse.microprofile.openapi.models.Components getComponents()  
      ApiContext getContext()  
      Map<String,​Set<String>> getEndpoints()  
      org.eclipse.microprofile.openapi.models.ExternalDocumentation getExternalDocs()  
      org.eclipse.microprofile.openapi.models.info.Info getInfo()  
      String getOpenapi()  
      org.eclipse.microprofile.openapi.models.Paths getPaths()  
      List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> getSecurity()  
      List<org.eclipse.microprofile.openapi.models.servers.Server> getServers()  
      List<org.eclipse.microprofile.openapi.models.tags.Tag> getTags()  
      static org.eclipse.microprofile.openapi.models.OpenAPI merge​(org.eclipse.microprofile.openapi.models.OpenAPI parent, List<org.eclipse.microprofile.openapi.models.OpenAPI> children, boolean override)  
      static void merge​(org.eclipse.microprofile.openapi.models.OpenAPI from, org.eclipse.microprofile.openapi.models.OpenAPI to, boolean override, ApiContext context)  
      void removeSecurityRequirement​(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)  
      void removeServer​(org.eclipse.microprofile.openapi.models.servers.Server server)  
      void removeTag​(org.eclipse.microprofile.openapi.models.tags.Tag tag)  
      void setComponents​(org.eclipse.microprofile.openapi.models.Components components)  
      void setEndpoints​(Map<String,​Set<String>> endpoints)  
      void setExternalDocs​(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)  
      void setInfo​(org.eclipse.microprofile.openapi.models.info.Info info)  
      void setOpenapi​(String openapi)  
      void setPaths​(org.eclipse.microprofile.openapi.models.Paths paths)  
      void setSecurity​(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)  
      void setServers​(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)  
      void setTags​(List<org.eclipse.microprofile.openapi.models.tags.Tag> tags)  
      • Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

        addExtension, extensions, getExtensions, removeExtension, setExtensions
      • Methods inherited from interface org.eclipse.microprofile.openapi.models.OpenAPI

        components, externalDocs, info, openapi, paths, security, servers, tags
    • Field Detail

      • openapi

        protected String openapi
      • info

        protected org.eclipse.microprofile.openapi.models.info.Info info
      • externalDocs

        protected org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs
      • servers

        protected List<org.eclipse.microprofile.openapi.models.servers.Server> servers
      • security

        protected List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security
      • tags

        protected List<org.eclipse.microprofile.openapi.models.tags.Tag> tags
      • paths

        protected org.eclipse.microprofile.openapi.models.Paths paths
      • components

        protected org.eclipse.microprofile.openapi.models.Components components
    • Constructor Detail

      • OpenAPIImpl

        public OpenAPIImpl()
    • Method Detail

      • createInstance

        public static org.eclipse.microprofile.openapi.models.OpenAPI createInstance​(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation,
                                                                                     ApiContext context)
      • getContext

        public final ApiContext getContext()
      • getOpenapi

        public String getOpenapi()
        Specified by:
        getOpenapi in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setOpenapi

        public void setOpenapi​(String openapi)
        Specified by:
        setOpenapi in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • getInfo

        public org.eclipse.microprofile.openapi.models.info.Info getInfo()
        Specified by:
        getInfo in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setInfo

        public void setInfo​(org.eclipse.microprofile.openapi.models.info.Info info)
        Specified by:
        setInfo in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • getExternalDocs

        public org.eclipse.microprofile.openapi.models.ExternalDocumentation getExternalDocs()
        Specified by:
        getExternalDocs in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setExternalDocs

        public void setExternalDocs​(org.eclipse.microprofile.openapi.models.ExternalDocumentation externalDocs)
        Specified by:
        setExternalDocs in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • getServers

        public List<org.eclipse.microprofile.openapi.models.servers.Server> getServers()
        Specified by:
        getServers in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setServers

        public void setServers​(List<org.eclipse.microprofile.openapi.models.servers.Server> servers)
        Specified by:
        setServers in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • addServer

        public org.eclipse.microprofile.openapi.models.OpenAPI addServer​(org.eclipse.microprofile.openapi.models.servers.Server server)
        Specified by:
        addServer in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • removeServer

        public void removeServer​(org.eclipse.microprofile.openapi.models.servers.Server server)
        Specified by:
        removeServer in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • getSecurity

        public List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> getSecurity()
        Specified by:
        getSecurity in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setSecurity

        public void setSecurity​(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> security)
        Specified by:
        setSecurity in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • addSecurityRequirement

        public org.eclipse.microprofile.openapi.models.OpenAPI addSecurityRequirement​(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)
        Specified by:
        addSecurityRequirement in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • removeSecurityRequirement

        public void removeSecurityRequirement​(org.eclipse.microprofile.openapi.models.security.SecurityRequirement securityRequirement)
        Specified by:
        removeSecurityRequirement in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • getTags

        public List<org.eclipse.microprofile.openapi.models.tags.Tag> getTags()
        Specified by:
        getTags in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setTags

        public void setTags​(List<org.eclipse.microprofile.openapi.models.tags.Tag> tags)
        Specified by:
        setTags in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • addTag

        public org.eclipse.microprofile.openapi.models.OpenAPI addTag​(org.eclipse.microprofile.openapi.models.tags.Tag tag)
        Specified by:
        addTag in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • removeTag

        public void removeTag​(org.eclipse.microprofile.openapi.models.tags.Tag tag)
        Specified by:
        removeTag in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • getPaths

        public org.eclipse.microprofile.openapi.models.Paths getPaths()
        Specified by:
        getPaths in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setPaths

        public void setPaths​(org.eclipse.microprofile.openapi.models.Paths paths)
        Specified by:
        setPaths in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • getComponents

        public org.eclipse.microprofile.openapi.models.Components getComponents()
        Specified by:
        getComponents in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • setComponents

        public void setComponents​(org.eclipse.microprofile.openapi.models.Components components)
        Specified by:
        setComponents in interface org.eclipse.microprofile.openapi.models.OpenAPI
      • merge

        public static org.eclipse.microprofile.openapi.models.OpenAPI merge​(org.eclipse.microprofile.openapi.models.OpenAPI parent,
                                                                            List<org.eclipse.microprofile.openapi.models.OpenAPI> children,
                                                                            boolean override)
      • merge

        public static void merge​(org.eclipse.microprofile.openapi.models.OpenAPI from,
                                 org.eclipse.microprofile.openapi.models.OpenAPI to,
                                 boolean override,
                                 ApiContext context)