BreakEdgeEvent (PLANitAllJavaOnly 0.4.0 API)

java.lang.Object
- org.goplanit.utils.id.IdAbleImpl
- - org.goplanit.utils.event.EventImpl
  - - org.goplanit.graph.modifier.event.BreakEdgeEvent

All Implemented Interfaces:

Comparable<IdAble>, Event, GraphModificationEvent, IdAble
```
public class BreakEdgeEvent
extends EventImpl
implements GraphModificationEvent
```
Wrapper around break edge event

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static GraphModifierEventType EVENT_TYPE
event type fired off when edge has been broken

Constructor Summary

Constructors
Constructor	Description
`BreakEdgeEvent(GraphModifier<?,?> source, Vertex vertexToBreakAt, Edge aToBreak, Edge breakToB)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Edge`	`getEdgeFromBreakToVertexB()`	collect broken edge section from break vertex to original vertex B
`Edge`	`getEdgeFromVertexAToBreak()`	collect broken edge section from original vertex A to break vertex
`Vertex`	`getVertexToBreakAt()`	Collect vertex to break at

Methods inherited from class org.goplanit.utils.event.EventImpl
deepClone, getContent, getSource, getType, shallowClone, toString

Methods inherited from class org.goplanit.utils.id.IdAbleImpl
equals, generateAndSetId, generateId, getId, hashCode, setId

Methods inherited from class java.lang.Object
clone, 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
compareTo, deepClone, getId, idEquals, idHashCode, shallowClone

- Field Detail
  - EVENT_TYPE
```
public static final GraphModifierEventType EVENT_TYPE
```
    event type fired off when edge has been broken
- Constructor Detail
  - BreakEdgeEvent
```
public BreakEdgeEvent(GraphModifier<?,?> source,
                      Vertex vertexToBreakAt,
                      Edge aToBreak,
                      Edge breakToB)
```
    Constructor
    
    Parameters:
    
    source - of the event
    
    vertexToBreakAt - vertex to break at
    
    aToBreak - edge broken now from vertex a to break
    
    breakToB - edge broken now from break to b vertex
- Method Detail
  - getVertexToBreakAt
```
public Vertex getVertexToBreakAt()
```
    Collect vertex to break at
    
    Returns:
    
    vertex to break at
  - getEdgeFromVertexAToBreak
```
public Edge getEdgeFromVertexAToBreak()
```
    collect broken edge section from original vertex A to break vertex
    
    Returns:
    
    edge
  - getEdgeFromBreakToVertexB
```
public Edge getEdgeFromBreakToVertexB()
```
    collect broken edge section from break vertex to original vertex B
    
    Returns:
    
    edge