@ApiAudience.Framework @ApiStability.Evolving public final class ApiStability {
@ApiAudience.Framework @ApiStability.Evolving public final class ApiAudience {
@ApiAudience.Framework @ApiStability.Evolving public final class Inheritance {
@ApiAudience.Framework @ApiStability.Evolving @Inheritance.Sealed
@ApiAudience.Framework public final class Priority {
@ApiAudience.Framework @ApiStability.Evolving @Inheritance.Sealed
@ApiAudience.Framework @ApiStability.Evolving public final class BytesKey {
/** Interface for factories of FijiCellDecoder instances. */ @ApiAudience.Framework @ApiStability.Evolving @Inheritance.Sealed public interface FijiCellDecoderFactory { /** * Creates a new Fiji cell decoder. * * @param cellSpec Specification of the cell encoding. * @return a new Fiji cell decoder. * @throws IOException on I/O error. * * @param <T> Type of the value to decode. */ <T> FijiCellDecoder<T> create(CellSpec cellSpec) throws IOException; /** * Creates a new Fiji cell decoder. * * @param layout FijiTableLayout from which to retrieve storage information. * @param spec Specification of the cell encoding. * @return a new Fiji cell decoder. * @throws IOException on I/O error. * * @param <T> Type of the value to decode. */ <T> FijiCellDecoder<T> create(FijiTableLayout layout, BoundColumnReaderSpec spec) throws IOException; }
@ApiAudience.Framework abstract class FijiMRPlatformBridgeFactory implements PriorityProvider {
@ApiAudience.Framework @ApiStability.Evolving public final class JobIOConfKeys {
@ApiAudience.Framework @ApiStability.Experimental public class CloseClusterConnectionsShutdownHook extends Thread {
@ApiAudience.Framework @ApiStability.Evolving @Inheritance.Sealed
/** Constants used by Fiji. */ @ApiAudience.Framework @ApiStability.Evolving public final class KConstants { /** Default fiji instance name. */ public static final String DEFAULT_INSTANCE_NAME = "default"; /** Default Fiji URI, pointing to the default HBase cluster. */ public static final String DEFAULT_HBASE_URI = "fiji://.env"; /** Default Fiji URI with instance specified as 'default'. */ public static final String DEFAULT_INSTANCE_URI = String.format("%s/%s", DEFAULT_HBASE_URI, DEFAULT_INSTANCE_NAME); /** Default Fiji URI, as built by FijiURI.newBuilder().build(). */ public static final String DEFAULT_URI = DEFAULT_INSTANCE_URI; public static final long END_OF_TIME = Long.MAX_VALUE; public static final long BEGINNING_OF_TIME = 0; /** Utility classes cannot be instantiated. */ private KConstants() { } }
/** * Responsible for deserializing FijiRowFilters from the results of a call to * {@link FijiRowFilter#toJson}. */ @ApiAudience.Framework @ApiStability.Evolving @Inheritance.Extensible public interface FijiRowFilterDeserializer { /** * Deserialize JSON into a {@code FijiRowFilter}. * * @param root the {@code JsonNode} holding the contents of the filter * @return a fully populated and operable {@code FijiRowFilter} */ FijiRowFilter createFromJson(JsonNode root); }
/** Interface for factories of FijiCellEncoder instances. */ @ApiAudience.Framework @ApiStability.Evolving @Inheritance.Sealed public interface FijiCellEncoderFactory { /** * Creates a new Fiji cell encoder. * * @param cellSpec Specification of the cell encoding. * @return a new Fiji cell encoder. * @throws IOException on I/O error. */ FijiCellEncoder create(CellSpec cellSpec) throws IOException; }
/** * Thrown to indicate that a flag is required but not supplied. */ @ApiAudience.Framework @ApiStability.Stable public final class RequiredFlagException extends Exception { /** * Creates a new <code>RequiredFlagException</code> for the specified flag name. * * @param flagName The name of the flag without the '--'. */ public RequiredFlagException(String flagName) { super("Must provide flag --" + flagName + "."); } }
/** * Iterator of FijiCells which may in the future provide additional methods specific to iterating * over the contents of a FijiResult. * * @param <T> Type of the value in the cells returned by this Iterator. */ @ApiAudience.Framework @ApiStability.Experimental @Inheritance.Sealed public interface FijiResultIterator<T> extends Iterator<FijiCell<T>> {}
/** * Interface for a closeable iterable. * * @param <T> the type returned by .iterator().next() */ @ApiAudience.Framework @ApiStability.Stable @Inheritance.Sealed public interface CloseableIterable<T> extends Closeable, Iterable<T> {}
/** Thrown when a JobInputSpec or JobOutputSpec cannot be parsed. */ @ApiAudience.Framework @ApiStability.Stable public final class JobIOSpecParseException extends RuntimeException { /** * @param message A message describing the problem with parsing. * @param spec The spec string that could not be parsed. */ public JobIOSpecParseException(String message, String spec) { super(message + " [spec=" + spec + "]"); } }
/** * A scanner over rows in a FijiTable. Rows are returned as {@link FijiResult}s. * {@code FijiResultScanner} must be closed when it will no longer be used. * * @param <T> type of {@code FijiCell} value returned by scanned {@code FijiResult}s. */ @ApiAudience.Framework @ApiStability.Experimental @Inheritance.Sealed public interface FijiResultScanner<T> extends Closeable, Iterator<FijiResult<T>> { }