com.epam.deltix.timebase.messages.schema.SchemaFieldChangeActionInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of timebase-messages Show documentation

Timebase Common utilities and collections

There is a newer version: 6.0.66

/*
 * Copyright 2021 EPAM Systems, Inc
 *
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership. 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 com.epam.deltix.timebase.messages.schema;

import com.epam.deltix.timebase.messages.RecordInfo;
import java.lang.Override;

/**
 * Class which defines a change to schema field.
 */
public interface SchemaFieldChangeActionInfo extends RecordInfo {
  /**
   * Previous data field state.
   * @return Previous State
   */
  DataFieldInfo getPreviousState();

  /**
   * Previous data field state.
   * @return true if Previous State is not null
   */
  boolean hasPreviousState();

  /**
   * New descriptor state.
   * @return New State
   */
  DataFieldInfo getNewState();

  /**
   * New descriptor state.
   * @return true if New State is not null
   */
  boolean hasNewState();

  /**
   * Bitmask that defines the changes that were applied to the field.
   * @return Change Types
   */
  SchemaFieldChangeType getChangeTypes();

  /**
   * Bitmask that defines the changes that were applied to the field.
   * @return true if Change Types is not null
   */
  boolean hasChangeTypes();

  /**
   * Defines the data transformation that was applied to the field.
   * @return Data Transformation
   */
  SchemaFieldDataTransformationInfo getDataTransformation();

  /**
   * Defines the data transformation that was applied to the field.
   * @return true if Data Transformation is not null
   */
  boolean hasDataTransformation();

  /**
   * Method copies state to a given instance
   */
  @Override
  SchemaFieldChangeActionInfo clone();
}