CatalogArchetypeDataSource (Maven Archetype Common 2.3 API)

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.archetype.source.CatalogArchetypeDataSource

All Implemented Interfaces:: ArchetypeDataSource, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:: InternalCatalogArchetypeDataSource, RemoteCatalogArchetypeDataSource

@Component(role=ArchetypeDataSource.class,
           hint="catalog")
public class CatalogArchetypeDataSource
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements ArchetypeDataSource

Author:: Jason van Zyl

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ARCHETYPE_CATALOG_FILENAME`
`static String`	`ARCHETYPE_CATALOG_PROPERTY`
`static File`	`DEFAULT_ARCHETYPE_CATALOG`
`static File`	`MAVEN_CONFIGURATION`
`static File`	`USER_HOME`

Fields inherited from interface org.apache.maven.archetype.source.ArchetypeDataSource
ROLE

Constructor Summary

Constructors
Constructor and Description

CatalogArchetypeDataSource()

Constructors
Constructor and Description
`CatalogArchetypeDataSource()`

Method Summary

Methods
Modifier and Type	Method and Description
`ArchetypeCatalog`	`getArchetypeCatalog(Properties properties)`
`protected ArchetypeCatalog`	`readCatalog(Reader reader)`
`void`	`updateCatalog(Properties properties, Archetype archetype)`
`protected void`	`writeLocalCatalog(ArchetypeCatalog catalog, File catalogFile)`

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARCHETYPE_CATALOG_PROPERTY

public static final String ARCHETYPE_CATALOG_PROPERTY

See Also:: Constant Field Values

ARCHETYPE_CATALOG_FILENAME

public static final String ARCHETYPE_CATALOG_FILENAME

See Also:: Constant Field Values

USER_HOME
```
public static final File USER_HOME
```

MAVEN_CONFIGURATION

public static final File MAVEN_CONFIGURATION

DEFAULT_ARCHETYPE_CATALOG

public static final File DEFAULT_ARCHETYPE_CATALOG

Constructor Detail
- CatalogArchetypeDataSource
```
public CatalogArchetypeDataSource()
```

Method Detail

updateCatalog

public void updateCatalog(Properties properties,
                 Archetype archetype)
                   throws ArchetypeDataSourceException

Specified by:: updateCatalog in interface ArchetypeDataSource
Throws:: ArchetypeDataSourceException

getArchetypeCatalog

public ArchetypeCatalog getArchetypeCatalog(Properties properties)
                                     throws ArchetypeDataSourceException

Specified by:: getArchetypeCatalog in interface ArchetypeDataSource
Throws:: ArchetypeDataSourceException

writeLocalCatalog

protected void writeLocalCatalog(ArchetypeCatalog catalog,
                     File catalogFile)
                          throws ArchetypeDataSourceException

Throws:: ArchetypeDataSourceException

readCatalog

protected ArchetypeCatalog readCatalog(Reader reader)
                                throws ArchetypeDataSourceException

Throws:: ArchetypeDataSourceException

Class CatalogArchetypeDataSource

Field Summary

Fields inherited from interface org.apache.maven.archetype.source.ArchetypeDataSource

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

Methods inherited from class java.lang.Object

Field Detail

ARCHETYPE_CATALOG_PROPERTY

ARCHETYPE_CATALOG_FILENAME

USER_HOME

MAVEN_CONFIGURATION

DEFAULT_ARCHETYPE_CATALOG

Constructor Detail

CatalogArchetypeDataSource

Method Detail

updateCatalog

getArchetypeCatalog

writeLocalCatalog

readCatalog