|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ivy.Ivy
public class Ivy
Ivy is a free java based dependency manager. This class is the main class of Ivy, which acts as a Facade to all services offered by Ivy:
Field Summary | |
---|---|
static java.text.SimpleDateFormat |
DATE_FORMAT
|
Constructor Summary | |
---|---|
Ivy()
The default constructor of Ivy allows to create an instance of Ivy with none of its dependencies (engines, settings, ...) created. |
Method Summary | |
---|---|
void |
bind()
This method is used to bind this Ivy instance to required dependencies, i.e. instance of settings, engines, and so on. |
boolean |
check(java.net.URL ivyFile,
java.lang.String resolvername)
|
void |
checkInterrupted()
Check if the current operation has been interrupted, and if it is the case, throw a runtime exception |
void |
configure(java.io.File settingsFile)
|
void |
configure(java.net.URL settingsURL)
|
void |
configureDefault()
|
void |
configureDefault14()
Configures Ivy with 1.4 compatible default settings |
void |
deliver(ModuleRevisionId mrid,
java.lang.String revision,
java.lang.String destIvyPattern)
|
void |
deliver(ModuleRevisionId mrid,
java.lang.String revision,
java.lang.String destIvyPattern,
DeliverOptions options)
Example of use: deliver(mrid, "1.5", "target/ivy/ivy-[revision].xml", DeliverOptions.newInstance(settings).setStatus("release").setValidate(false)); |
void |
deliver(java.lang.String revision,
java.lang.String destIvyPattern,
DeliverOptions options)
|
ResolvedModuleRevision |
findModule(ModuleRevisionId mrid)
|
CacheManager |
getCacheManager(java.io.File cache)
|
CheckEngine |
getCheckEngine()
|
DeliverEngine |
getDeliverEngine()
|
EventManager |
getEventManager()
|
InstallEngine |
getInstallEngine()
|
PublishEngine |
getPublishEngine()
|
ResolveEngine |
getResolveEngine()
|
RetrieveEngine |
getRetrieveEngine()
|
SearchEngine |
getSearchEngine()
|
IvySettings |
getSettings()
|
SortEngine |
getSortEngine()
|
java.lang.String |
getVariable(java.lang.String name)
|
static java.lang.String |
getWorkingRevision()
|
ResolveReport |
install(ModuleRevisionId mrid,
java.lang.String from,
java.lang.String to,
boolean transitive,
boolean validate,
boolean overwrite,
Filter artifactFilter,
java.io.File cache,
java.lang.String matcherName)
|
void |
interrupt()
Interrupts the current running operation, no later than interruptTimeout milliseconds after the call |
void |
interrupt(java.lang.Thread operatingThread)
Interrupts the current running operation in the given operating thread, no later than interruptTimeout milliseconds after the call |
boolean |
isInterrupted()
|
ModuleEntry[] |
listModuleEntries(OrganisationEntry org)
|
ModuleId[] |
listModules(ModuleId criteria,
PatternMatcher matcher)
|
ModuleRevisionId[] |
listModules(ModuleRevisionId criteria,
PatternMatcher matcher)
|
java.lang.String[] |
listModules(java.lang.String org)
|
OrganisationEntry[] |
listOrganisationEntries()
|
java.lang.String[] |
listOrganisations()
|
RevisionEntry[] |
listRevisionEntries(ModuleEntry module)
|
java.lang.String[] |
listRevisions(java.lang.String org,
java.lang.String module)
|
java.lang.String[] |
listTokenValues(java.lang.String token,
java.util.Map otherTokenValues)
|
static Ivy |
newInstance()
|
java.util.Collection |
publish(ModuleRevisionId mrid,
java.util.Collection srcArtifactPattern,
java.lang.String resolverName,
PublishOptions options)
|
ResolveReport |
resolve(java.io.File ivySource)
|
ResolveReport |
resolve(ModuleDescriptor md,
ResolveOptions options)
|
ResolveReport |
resolve(ModuleRevisionId mrid,
ResolveOptions options,
boolean changing)
|
ResolveReport |
resolve(java.net.URL ivySource)
|
ResolveReport |
resolve(java.net.URL ivySource,
ResolveOptions options)
|
int |
retrieve(ModuleRevisionId mrid,
java.lang.String destFilePattern,
RetrieveOptions options)
|
void |
setCheckEngine(CheckEngine checkEngine)
|
void |
setDeliverEngine(DeliverEngine deliverEngine)
|
void |
setEventManager(EventManager eventManager)
|
void |
setInstallEngine(InstallEngine installEngine)
|
void |
setPublishEngine(PublishEngine publishEngine)
|
void |
setResolveEngine(ResolveEngine resolveEngine)
|
void |
setRetrieveEngine(RetrieveEngine retrieveEngine)
|
void |
setSearchEngine(SearchEngine searchEngine)
|
void |
setSettings(IvySettings settings)
|
void |
setSortEngine(SortEngine sortEngine)
|
void |
setVariable(java.lang.String varName,
java.lang.String value)
|
java.util.List |
sortModuleDescriptors(java.util.Collection moduleDescriptors)
Sorts the given ModuleDescriptors from the less dependent to the more dependent. |
java.util.List |
sortNodes(java.util.Collection nodes)
Sorts the collection of IvyNode from the less dependent to the more dependent |
java.lang.String |
substitute(java.lang.String str)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.text.SimpleDateFormat DATE_FORMAT
Constructor Detail |
---|
public Ivy()
Method Detail |
---|
public static Ivy newInstance()
public void bind()
public void configure(java.io.File settingsFile) throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public void configure(java.net.URL settingsURL) throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public void configureDefault() throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public void configureDefault14() throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public boolean check(java.net.URL ivyFile, java.lang.String resolvername)
public ResolveReport resolve(java.io.File ivySource) throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public ResolveReport resolve(java.net.URL ivySource) throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public ResolveReport resolve(ModuleRevisionId mrid, ResolveOptions options, boolean changing) throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public ResolveReport resolve(java.net.URL ivySource, ResolveOptions options) throws java.text.ParseException, java.io.IOException
java.text.ParseException
java.io.IOException
public ResolveReport resolve(ModuleDescriptor md, ResolveOptions options) throws java.text.ParseException, java.io.IOException, java.io.FileNotFoundException
java.text.ParseException
java.io.IOException
java.io.FileNotFoundException
public ResolveReport install(ModuleRevisionId mrid, java.lang.String from, java.lang.String to, boolean transitive, boolean validate, boolean overwrite, Filter artifactFilter, java.io.File cache, java.lang.String matcherName) throws java.io.IOException
java.io.IOException
public int retrieve(ModuleRevisionId mrid, java.lang.String destFilePattern, RetrieveOptions options) throws java.io.IOException
java.io.IOException
public void deliver(ModuleRevisionId mrid, java.lang.String revision, java.lang.String destIvyPattern) throws java.io.IOException, java.text.ParseException
java.io.IOException
java.text.ParseException
public void deliver(java.lang.String revision, java.lang.String destIvyPattern, DeliverOptions options) throws java.io.IOException, java.text.ParseException
java.io.IOException
java.text.ParseException
public void deliver(ModuleRevisionId mrid, java.lang.String revision, java.lang.String destIvyPattern, DeliverOptions options) throws java.io.IOException, java.text.ParseException
mrid
- revision
- destIvyPattern
- options
-
java.io.IOException
java.text.ParseException
public java.util.Collection publish(ModuleRevisionId mrid, java.util.Collection srcArtifactPattern, java.lang.String resolverName, PublishOptions options) throws java.io.IOException
java.io.IOException
public java.util.List sortNodes(java.util.Collection nodes)
public java.util.List sortModuleDescriptors(java.util.Collection moduleDescriptors)
moduleDescriptors
- a Collection of ModuleDescriptor to sort
public ResolvedModuleRevision findModule(ModuleRevisionId mrid)
public ModuleEntry[] listModuleEntries(OrganisationEntry org)
public ModuleId[] listModules(ModuleId criteria, PatternMatcher matcher)
public ModuleRevisionId[] listModules(ModuleRevisionId criteria, PatternMatcher matcher)
public java.lang.String[] listModules(java.lang.String org)
public OrganisationEntry[] listOrganisationEntries()
public java.lang.String[] listOrganisations()
public RevisionEntry[] listRevisionEntries(ModuleEntry module)
public java.lang.String[] listRevisions(java.lang.String org, java.lang.String module)
public java.lang.String[] listTokenValues(java.lang.String token, java.util.Map otherTokenValues)
public void interrupt()
public void interrupt(java.lang.Thread operatingThread)
public boolean isInterrupted()
public void checkInterrupted()
public static java.lang.String getWorkingRevision()
public CacheManager getCacheManager(java.io.File cache)
public java.lang.String getVariable(java.lang.String name)
public java.lang.String substitute(java.lang.String str)
public void setVariable(java.lang.String varName, java.lang.String value)
public IvySettings getSettings()
public EventManager getEventManager()
public CheckEngine getCheckEngine()
public void setCheckEngine(CheckEngine checkEngine)
public DeliverEngine getDeliverEngine()
public void setDeliverEngine(DeliverEngine deliverEngine)
public InstallEngine getInstallEngine()
public void setInstallEngine(InstallEngine installEngine)
public PublishEngine getPublishEngine()
public void setPublishEngine(PublishEngine publishEngine)
public ResolveEngine getResolveEngine()
public void setResolveEngine(ResolveEngine resolveEngine)
public RetrieveEngine getRetrieveEngine()
public void setRetrieveEngine(RetrieveEngine retrieveEngine)
public SearchEngine getSearchEngine()
public void setSearchEngine(SearchEngine searchEngine)
public SortEngine getSortEngine()
public void setSortEngine(SortEngine sortEngine)
public void setEventManager(EventManager eventManager)
public void setSettings(IvySettings settings)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |