Class ApiDocManager

  • All Implemented Interfaces:
    org.onosproject.rest.ApiDocService

    public class ApiDocManager
    extends java.lang.Object
    implements org.onosproject.rest.ApiDocService
    Implementation of the REST API documentation tracker.
    • Constructor Summary

      Constructors 
      Constructor Description
      ApiDocManager()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void activate()  
      void deactivate()  
      org.onosproject.rest.ApiDocProvider getDocProvider​(java.lang.String key)  
      java.util.Set<org.onosproject.rest.ApiDocProvider> getDocProviders()  
      void register​(org.onosproject.rest.ApiDocProvider provider)  
      void unregister​(org.onosproject.rest.ApiDocProvider provider)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ApiDocManager

        public ApiDocManager()
    • Method Detail

      • activate

        public void activate()
      • deactivate

        public void deactivate()
      • register

        public void register​(org.onosproject.rest.ApiDocProvider provider)
        Specified by:
        register in interface org.onosproject.rest.ApiDocService
      • unregister

        public void unregister​(org.onosproject.rest.ApiDocProvider provider)
        Specified by:
        unregister in interface org.onosproject.rest.ApiDocService
      • getDocProviders

        public java.util.Set<org.onosproject.rest.ApiDocProvider> getDocProviders()
        Specified by:
        getDocProviders in interface org.onosproject.rest.ApiDocService
      • getDocProvider

        public org.onosproject.rest.ApiDocProvider getDocProvider​(java.lang.String key)
        Specified by:
        getDocProvider in interface org.onosproject.rest.ApiDocService