AbstractArtifactRepresentation (EASy-Producer Documentation API)

java.lang.Object
- net.ssehub.easy.instantiation.core.model.artifactModel.representation.AbstractArtifactRepresentation

All Implemented Interfaces:

IArtifactRepresentation, IVilType

Direct Known Subclasses:

Binary, Text
```
public abstract class AbstractArtifactRepresentation
extends java.lang.Object
implements IArtifactRepresentation
```
An abstract implementation of artifact representations which cares for modifiability and for listeners.

Author:

Holger Eichelberger

Field Summary

Fields
Modifier and Type Field Description

private ArtifactChangedListenerQueue listeners

private boolean modifiable

private boolean triggerEnabled

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractArtifactRepresentation(boolean modifiable)
Creates a artifact representation and sets the modifiability flag.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IArtifactChangedListenerQueue`	`getListeners()`	Returns the change listeners.
`protected boolean`	`isModifiable()`	Returns whether the representation is modifiable.
`void`	`setTriggerEnabled(boolean triggerEnabled)`	May be used to avoid superfluous listener triggers.
`void`	`triggerArtifactChanged()`	Triggers all registerered listeners in `getListeners()`.

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

Methods inherited from interface net.ssehub.easy.instantiation.core.model.artifactModel.representation.IArtifactRepresentation
isEmpty, updateContents

- Field Detail
  - triggerEnabled
```
private boolean triggerEnabled
```
  - modifiable
```
private boolean modifiable
```
  - listeners
```
private ArtifactChangedListenerQueue listeners
```
- Constructor Detail
  - AbstractArtifactRepresentation
```
protected AbstractArtifactRepresentation(boolean modifiable)
```
    Creates a artifact representation and sets the modifiability flag.
    
    Parameters:
    
    modifiable - whether the representation is modifiable
- Method Detail
  - isModifiable
```
protected boolean isModifiable()
```
    Returns whether the representation is modifiable.
    
    Returns:
    
    true if it is modifiable, false else
  - getListeners
```
public IArtifactChangedListenerQueue getListeners()
```
    Description copied from interface: IArtifactRepresentation
    
    Returns the change listeners.
    
    Specified by:
    
    getListeners in interface IArtifactRepresentation
    
    Returns:
    
    the change listeners
  - triggerArtifactChanged
```
public void triggerArtifactChanged()
                            throws VilException
```
    Triggers all registerered listeners in getListeners().
    
    Throws:
    
    VilException - in case that some listeners fail
  - setTriggerEnabled
```
public void setTriggerEnabled(boolean triggerEnabled)
```
    May be used to avoid superfluous listener triggers.
    
    Parameters:
    
    triggerEnabled - enabled if true, disabled if false