java/core/src/java/org/apache/orc/DataMaskDescription.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.orc;

/**
 * Information about the DataMask used to mask the unencrypted data.
 */
public interface DataMaskDescription {

  /**
   * The name of the mask.
   * @return the name
   */
  String getName();

  /**
   * The parameters for the mask
   * @return the array of parameters
   */
  String[] getParameters();

  /**
   * Get the list of columns that use this mask.
   * @return the list of columns
   */
  TypeDescription[] getColumns();
}