Package org.apache.ivy.core.event

Class IvyEvent

java.lang.Object
org.apache.ivy.core.event.IvyEvent
Direct Known Subclasses:
DownloadEvent, PrepareDownloadEvent, PublishEvent, ResolveDependencyEvent, ResolveEvent, RetrieveArtifactEvent, RetrieveEvent, TransferEvent
public class IvyEvent extends Object

The root of all ivy events Any ivy event knows which ivy instance triggered the event (the source) and also has a name and a map of attributes. The name of the event represents the event type, usually there is a one - one mapping between event names and IvyEvent subclass, even if this is not mandatory. Example: pre-resolve pre-resolve-dependency post-download

The map of attributes is a Map from String keys to String values. It is especially useful to filter events, and to get some of their essential data in some context where access to Java types is not easy (in an Ant build file, for example), Example: pre-resolve (organisation=foo, module=bar, revision=1.0, conf=default) post-download (organisation=foo, module=bar, revision=1.0, artifact=foo-test, type=jar, ext=jar)

  • Constructor Details

    • IvyEvent

      protected IvyEvent(String name)

  • Method Details

    • addAttribute

      protected void addAttribute(String key, String value)
      Should only be called during event object construction, since events should be immutable
      Parameters:
      key - ditto
      value - ditto

    • addMDAttributes

      protected void addMDAttributes(ModuleDescriptor md)

    • addMridAttributes

      protected void addMridAttributes(ModuleRevisionId mrid)

    • addModuleIdAttributes

      protected void addModuleIdAttributes(ModuleId moduleId)

    • addConfsAttribute

      protected void addConfsAttribute(String[] confs)

    • addAttributes

      protected void addAttributes(Map<String,String> attributes)

    • getSource

      public EventManager getSource()

    • getName

      public String getName()

    • getAttributes

      public Map<String,String> getAttributes()
      Returns the attributes of this event, as a Map(String,String)
      Returns:
      the attributes of this event, as a Map(String,String)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object