org.nuxeo.apidoc.adapters

Class ComponentInfoDocAdapter

java.lang.Object

org.nuxeo.apidoc.api.BaseNuxeoArtifact

org.nuxeo.apidoc.adapters.BaseNuxeoArtifactDocAdapter

org.nuxeo.apidoc.adapters.ComponentInfoDocAdapter

All Implemented Interfaces:

ComponentInfo, NuxeoArtifact

public class ComponentInfoDocAdapter
extends BaseNuxeoArtifactDocAdapter
implements ComponentInfo

Field Summary

Fields inherited from interface org.nuxeo.apidoc.api.ComponentInfo

PROP_BUILT_IN_DOC, PROP_COMPONENT_CLASS, PROP_COMPONENT_ID, PROP_COMPONENT_NAME, PROP_IS_XML, PROP_SERVICES, TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
ComponentInfoDocAdapter(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
static ComponentInfoDocAdapter	create(ComponentInfo componentInfo, CoreSession session, String containerPath)
String	getArtifactType()
BundleInfo	getBundle()
String	getComponentClass()
String	getDocumentation()
String	getDocumentationHtml()
ExtensionPointInfo	getExtensionPoint(String name)
Collection<ExtensionPointInfo>	getExtensionPoints()
Collection<ExtensionInfo>	getExtensions()
String	getId()
String	getName()
List<String>	getServiceNames()
List<ServiceInfo>	getServices()
String	getVersion()
String	getXmlFileContent()
String	getXmlFileName()
URL	getXmlFileUrl()
boolean	isXmlPureComponent()

Methods inherited from class org.nuxeo.apidoc.adapters.BaseNuxeoArtifactDocAdapter

getDoc, getHierarchyPath, hashCode, releaseLocalCoreSession, setLocalCoreSession

Methods inherited from class org.nuxeo.apidoc.api.BaseNuxeoArtifact

getAssociatedDocuments

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.apidoc.api.NuxeoArtifact

getAssociatedDocuments, getHierarchyPath

Constructor Detail

ComponentInfoDocAdapter

public ComponentInfoDocAdapter(DocumentModel doc)

Method Detail

create

public static ComponentInfoDocAdapter create(ComponentInfo componentInfo,
                             CoreSession session,
                             String containerPath)
                                      throws Exception

Throws:

Exception

getBundle

public BundleInfo getBundle()

Specified by:

getBundle in interface ComponentInfo

getComponentClass

public String getComponentClass()

Specified by:

getComponentClass in interface ComponentInfo

getDocumentation

public String getDocumentation()

Specified by:

getDocumentation in interface ComponentInfo

getDocumentationHtml

public String getDocumentationHtml()

Specified by:

getDocumentationHtml in interface ComponentInfo

getExtensionPoint

public ExtensionPointInfo getExtensionPoint(String name)

Specified by:

getExtensionPoint in interface ComponentInfo

getExtensionPoints

public Collection<ExtensionPointInfo> getExtensionPoints()

Specified by:

getExtensionPoints in interface ComponentInfo

getExtensions

public Collection<ExtensionInfo> getExtensions()

Specified by:

getExtensions in interface ComponentInfo

getName

public String getName()

Specified by:

getName in interface ComponentInfo

getServiceNames

public List<String> getServiceNames()

Specified by:

getServiceNames in interface ComponentInfo

getXmlFileContent

public String getXmlFileContent()
                         throws IOException

Specified by:

getXmlFileContent in interface ComponentInfo

Throws:

IOException

getXmlFileName

public String getXmlFileName()

Specified by:

getXmlFileName in interface ComponentInfo

getXmlFileUrl

public URL getXmlFileUrl()

Specified by:

getXmlFileUrl in interface ComponentInfo

isXmlPureComponent

public boolean isXmlPureComponent()

Specified by:

isXmlPureComponent in interface ComponentInfo

getId

public String getId()

Specified by:

getId in interface NuxeoArtifact

Specified by:

getId in class BaseNuxeoArtifact

getVersion

public String getVersion()

Specified by:

getVersion in interface NuxeoArtifact

getArtifactType

public String getArtifactType()

Specified by:

getArtifactType in interface NuxeoArtifact

getServices

public List<ServiceInfo> getServices()

Specified by:

getServices in interface ComponentInfo