org.eclipse.january.dataset

## Interface IMetadataProvider

- All Known Subinterfaces:
    CompoundDataset, Dataset, DateDataset, IDataset, IDynamicDataset, ILazyDataset, ILazyWriteableDataset
  All Known Implementing Classes:
    AbstractCompoundDataset, AbstractDataset, AggregateDataset, BooleanDataset, BooleanDatasetBase, ByteDataset, ComplexDoubleDataset, ComplexFloatDataset, CompoundByteDataset, CompoundDoubleDataset, CompoundFloatDataset, CompoundIntegerDataset, CompoundLongDataset, CompoundShortDataset, DateDatasetImpl, DoubleDataset, FloatDataset, IntegerDataset, LazyDataset, LazyDatasetBase, LazyDynamicDataset, LazyWriteableDataset, LongDataset, ObjectDataset, ObjectDatasetBase, RGBByteDataset, RGBDataset, ShortDataset, StringDataset, StringDatasetBase

      public interface IMetadataProvider

  Interface which acts to provide metadata from an object

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `<T extends MetadataType> T` | `getFirstMetadata(Class<T> clazz)`
    `IMetadata` | `getMetadata()` Deprecated. Use `getFirstMetadata(IMetadata.class)` instead
    `<T extends MetadataType> List<T>` | `getMetadata(Class<T> clazz)`

- - ### Method Detail

    - #### getMetadata

          @Deprecated
          IMetadata getMetadata()
                                     throws Exception

      Deprecated. Use `getFirstMetadata(IMetadata.class)` instead
      Returns:
        an instance of IMetadata
      Throws:
        `Exception` - when failing to fetch metadata

    - #### getMetadata

          <T extends MetadataType> List<T> getMetadata(Class<T> clazz)
                                                throws MetadataException

      Type Parameters:
        `T` - metadata sub-interface
      Parameters:
        `clazz` - if null return everything
      Returns:
        list of metadata with given class (or its super interface)
      Throws:
        `MetadataException` - when failing to fetch metadata

    - #### getFirstMetadata

          <T extends MetadataType> T getFirstMetadata(Class<T> clazz)

      Type Parameters:
        `T` - metadata sub-interface
      Parameters:
        `clazz` - if null return first from everything
      Returns:
        first element from list of metadata with given class (or its super interface)

Copyright © 2014–2022 Eclipse Foundation. All rights reserved.