DataMask.Factory (ORC Core 1.6.6 API)
Date: 2021-01-13

org.apache.orc

## Class DataMask.Factory

- java.lang.Object
- - org.apache.orc.DataMask.Factory

- Enclosing interface:
    DataMask

      public static class DataMask.Factory
      extends Object

  To create a DataMask, the users should come through this API. It supports extension via additional DataMask.Provider implementations that are accessed through Java's ServiceLoader API.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `Factory()`

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static DataMask` | `build(DataMaskDescription mask, TypeDescription schema, DataMask.MaskOverrides overrides)` Build a new DataMask instance.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Factory

          public Factory()

  - ### Method Detail

    - #### build

          public static DataMask build(DataMaskDescription mask,
                                       TypeDescription schema,
                                       DataMask.MaskOverrides overrides)

      Build a new DataMask instance.
      Parameters:
        `mask` - the description of the data mask
        `schema` - the type of the field
        `overrides` - sub-columns where the mask is overridden
      Returns:
        a new DataMask
      Throws:
        `IllegalArgumentException` - if no such kind of data mask was found
      See Also:
        `for the standard provider`

Copyright © 2013–2021 The Apache Software Foundation. All rights reserved.