SampleSource 5.6.3 API

All Implemented Interfaces:

java.lang.Runnable
```
public interface SampleSource
 implements Runnable
                    
```
The interface SampleSource represents a source of samples for sample consumers.

Since:

3.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract SampleContext`	`getSampleContext()`	Gets the sample context.
`abstract void`	`setSampleContext(SampleContext sampleContext)`	Sets the sample context.
`abstract void`	`setSampleConsumers(List<SampleConsumer> consumers)`	Sets the specified sample consumers that will consume samples produced by this sample source.
`abstract void`	`addSampleConsumer(SampleConsumer consumer)`	Add a sample consumer to this sample source.
`abstract void`	`removeSampleConsumer(SampleConsumer consumer)`	Remove a sample consumer from this sample source.

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

- Constructor Detail
- Method Detail
  - getSampleContext
```
 abstract SampleContext getSampleContext()
```
    Gets the sample context.
    
    Returns:
    
    the sampleContext
  - setSampleContext
```
 abstract void setSampleContext(SampleContext sampleContext)
```
    Sets the sample context.
    
    Parameters:
    
    sampleContext - the sampleContext to set
  - setSampleConsumers
```
 abstract void setSampleConsumers(List<SampleConsumer> consumers)
```
    Sets the specified sample consumers that will consume samples produced by this sample source.
    
    Parameters:
    
    consumers - consumers to be set
  - addSampleConsumer
```
 abstract void addSampleConsumer(SampleConsumer consumer)
```
    Add a sample consumer to this sample source.
    
    Parameters:
    
    consumer - consumer to be added
  - removeSampleConsumer
```
 abstract void removeSampleConsumer(SampleConsumer consumer)
```
    Remove a sample consumer from this sample source.
    
    Parameters:
    
    consumer - consumer to be removed