SingleUserActionRestriction

java.lang.Object
- edu.kit.ipd.sdq.eventsim.instrumentation.restrictions.useraction.SingleUserActionRestriction<A>

Type Parameters:

A - the type of the user action

All Implemented Interfaces:

InstrumentableRestriction<UserActionRepresentative>
```
public class SingleUserActionRestriction<A extends org.palladiosimulator.pcm.usagemodel.AbstractUserAction>
extends Object
implements InstrumentableRestriction<UserActionRepresentative>
```
A specific restriction for user actions excluding all user actions except for one. This user action is specified by the corresponding id.
Note that only one of this restriction per instrumentation rule should be introduced, since two different of them would produce an empty set.

Field Summary
- Fields inherited from interface edu.kit.ipd.sdq.eventsim.instrumentation.description.core.InstrumentableRestriction
  EXTENSION_POINT_ID

Constructor Summary

Constructors
Constructor	Description
`SingleUserActionRestriction()`
`SingleUserActionRestriction(A userAction)`
`SingleUserActionRestriction(String userActionId, Class<A> userActionType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`exclude(UserActionRepresentative action)`	Returns if an instrumentable is excluded.
`String`	`getHint()`
`String`	`getUserActionId()`
`Class<A>`	`getUserActionType()`
`void`	`setUserActionId(String userActionId)`
`void`	`setUserActionType(Class<A> userActionType)`

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

Methods inherited from interface edu.kit.ipd.sdq.eventsim.instrumentation.description.core.InstrumentableRestriction
filter

- Constructor Detail
  - SingleUserActionRestriction
```
public SingleUserActionRestriction(A userAction)
```
  - SingleUserActionRestriction
```
public SingleUserActionRestriction()
```
  - SingleUserActionRestriction
```
public SingleUserActionRestriction(String userActionId,
                                   Class<A> userActionType)
```
- Method Detail
  - exclude
```
public boolean exclude(UserActionRepresentative action)
```
    Description copied from interface: InstrumentableRestriction
    
    Returns if an instrumentable is excluded.
    
    Specified by:
    
    exclude in interface InstrumentableRestriction<A extends org.palladiosimulator.pcm.usagemodel.AbstractUserAction>
    
    Parameters:
    
    action - the instrumentable to be checked
    
    Returns:
    
    true, if the instrumentable should be excluded or false otherwise
  - getHint
```
public String getHint()
```
    Specified by:
    
    getHint in interface InstrumentableRestriction<A extends org.palladiosimulator.pcm.usagemodel.AbstractUserAction>
  - getUserActionId
```
public String getUserActionId()
```
  - setUserActionId
```
public void setUserActionId(String userActionId)
```
  - getUserActionType
```
public Class<A> getUserActionType()
```
  - setUserActionType
```
public void setUserActionType(Class<A> userActionType)
```