NTSampleIndexType

All Superinterfaces:: Comparable<NTSampleIndexType>

All Known Implementing Classes:: NTSampleIndex

@Immutable public interface NTSampleIndexType extends Comparable<NTSampleIndexType>

The valid values for sample indices.

Method Summary

Modifier and Type

Method

Description

default char

asUnsigned16()

default void

checkPreconditions()

Check preconditions for the type.

default int

compareTo(NTSampleIndexType other)

int

value()

Method Details
- value
  
  @Parameter int value()
  
  Returns:
  
  The raw value in the range [0, 0xffff]
- checkPreconditions
  
  @Check default void checkPreconditions()
  
  Check preconditions for the type.
- asUnsigned16
  
  default char asUnsigned16()
  
  Returns:
  
  The value as an unsigned 16-bit integer
- compareTo
  
  default int compareTo(NTSampleIndexType other)
  
  Specified by:
  
  compareTo in interface Comparable<NTSampleIndexType>