org.infrastructurebuilder.data.IBDataStreamRecordFinalizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ibdata-api Show documentation

APIs for dealing with data streams

The newest version!

/**
 * Copyright © 2019 admin ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.infrastructurebuilder.data;

import static java.util.Optional.empty;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Path;
import java.util.List;
import java.util.Optional;
import java.util.function.Supplier;

public interface IBDataStreamRecordFinalizer extends Supplier, AutoCloseable {
  public final static String NUMBER_OF_ROWS_TO_SKIP_PARAM = "numberOfRowsToSkip";

  String getId();

  default int getNumberOfRowsToSkip() {
    return 0;
  }

  /**
   * This method actually writes the final transformation.
   * @param recordToWrite
   * @return
   */
  Optional writeRecord(T recordToWrite);

  /**
   * This value
   * @return
   * @throws IOException
   */
  OutputStream getWriterTarget() throws IOException;

  Supplier finalizeRecord(IBDataStreamIdentifier ds);

  Path getWorkingPath();

  default Optional>> accepts() {
    return empty();
  }

  default Optional produces() {
    return empty();
  }
}