org.jboss.shrinkwrap.descriptor.api
Interface Descriptor

All Known Subinterfaces:
ApplicationDescriptor, ApplicationDescriptor, BeansDescriptor, ConnectorDescriptor, ConnectorDescriptor, ConnectorDescriptor, ConnectorDescriptor, DatasourcesDescriptor, EjbJarDescriptor, EjbJarDescriptor, IronjacamarDescriptor, JbossDescriptor, JbossWebDescriptor, JettyDescriptor, OrmDescriptor, OrmDescriptor, PersistenceDescriptor, PersistenceDescriptor, PortletDescriptor, ResourceadapterDescriptor, WebAppDescriptor, WebFacelettaglibraryDescriptor, WebFacesConfigDescriptor, WebFacesConfigDescriptor, WebFacesPartialResponseDescriptor, WebFacesUIComponentDescriptor, WebFragmentDescriptor, WebJsptaglibraryDescriptor, WebJsptaglibraryDescriptor
All Known Implementing Classes:
ConnectorDescriptorImpl, DatasourcesDescriptorImpl, org.jboss.shrinkwrap.descriptor.spi.DescriptorImplBase, IronjacamarDescriptorImpl, org.jboss.shrinkwrap.descriptor.spi.node.NodeDescriptorImplBase, ResourceadapterDescriptorImpl

public interface Descriptor

End-user domain-specific language (DSL) view of a metadata Descriptor.

Author:
Aslak Knutsen, ALR

Method Summary
 String exportAsString()
          Exports the descriptor as a String
 void exportTo(OutputStream output)
          Export the descriptor to a given OutputStream.
 String getDescriptorName()
          Get the Descriptor name.
 

Method Detail

getDescriptorName

String getDescriptorName()
Get the Descriptor name. The name can be specified by user at construction time, or predefined as a default by type.

Returns:
the descriptor name

exportAsString

String exportAsString()
                      throws DescriptorExportException
Exports the descriptor as a String

Returns:
Throws:
DescriptorExportException

exportTo

void exportTo(OutputStream output)
              throws DescriptorExportException,
                     IllegalArgumentException
Export the descriptor to a given OutputStream. The OutputStream will not be flushed or closed by this operation.

Parameters:
output - Where to export
Throws:
IllegalArgumentException - if output is null
DescriptorExportException - if problems exporting


Copyright © 2013 JBoss, a division of Red Hat, Inc.. All Rights Reserved.