PopulateGapFunctionEvent (planit-all 0.3.0 API)

java.lang.Object
- org.goplanit.utils.id.IdAbleImpl
- - org.goplanit.utils.event.EventImpl
  - - org.goplanit.component.event.PopulateUntypedComponentEvent
    - - org.goplanit.component.event.PopulateGapFunctionEvent

All Implemented Interfaces:

Cloneable, Comparable<IdAble>, PlanitComponentEvent, Event, IdAble
```
public class PopulateGapFunctionEvent
extends PopulateUntypedComponentEvent
```
A Populate gap function event is fired when PLANit requests for a registered listener to populate the newly created gap function instance. It is assumed only a single listener will populate this component and it is expected that the registration of this listener is handled by the platform rather than the user. The end user will - via the listener - receive this event when implementing an input builder and registering this builder on a PLANit project for example.

Author:

markr

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static PlanitComponentEventType EVENT_TYPE
  event type fired off when gap function needs to be populated
- Constructor Summary
  
  Constructors
  Constructor Description
  
  PopulateGapFunctionEvent(PlanitComponentFactory<?> source, GapFunction gapFunctionToPopulate)
  Constructor
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  GapFunction getGapFunctionToPopulate()
  collect gap function to populate
  - Methods inherited from class org.goplanit.component.event.PopulateUntypedComponentEvent
    getAdditionalContent, getComponentToPopulate
  - Methods inherited from class org.goplanit.utils.event.EventImpl
    clone, getContent, getSource, getType, toString
  - Methods inherited from class org.goplanit.utils.id.IdAbleImpl
    equals, generateAndSetId, generateId, getId, hashCode, setId
  - Methods inherited from class java.lang.Object
    finalize, getClass, notify, notifyAll, wait, wait, wait
  - Methods inherited from interface org.goplanit.utils.event.Event
    getSource, getType
  - Methods inherited from interface org.goplanit.utils.id.IdAble
    clone, compareTo, getId, idEquals, idHashCode

- Field Detail
  - EVENT_TYPE
```
public static final PlanitComponentEventType EVENT_TYPE
```
    event type fired off when gap function needs to be populated
- Constructor Detail
  - PopulateGapFunctionEvent
```
public PopulateGapFunctionEvent(PlanitComponentFactory<?> source,
                                GapFunction gapFunctionToPopulate)
```
    Constructor
    
    Parameters:
    
    source - of the event
    
    gapFunctionToPopulate - gap function to populate
- Method Detail
  - getGapFunctionToPopulate
```
public GapFunction getGapFunctionToPopulate()
```
    collect gap function to populate
    
    Returns:
    
    gap function