ceph/src/arrow/java/vector/src/main/java/org/apache/arrow/vector/ipc/ArrowMagic.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *    http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package org.apache.arrow.vector.ipc;
  19
  20 import java.io.IOException;
  21 import java.nio.charset.StandardCharsets;
  22 import java.util.Arrays;
  23
  24 /**
  25  * Magic header/footer helpers for {@link ArrowFileWriter} and {@link ArrowFileReader} formatted files.
  26  */
  27 class ArrowMagic {
  28   private ArrowMagic(){}
  29
  30   private static final byte[] MAGIC = "ARROW1".getBytes(StandardCharsets.UTF_8);
  31
  32   public static final int MAGIC_LENGTH = MAGIC.length;
  33
  34   public static void writeMagic(WriteChannel out, boolean align) throws IOException {
  35     out.write(MAGIC);
  36     if (align) {
  37       out.align();
  38     }
  39   }
  40
  41   public static boolean validateMagic(byte[] array) {
  42     return Arrays.equals(MAGIC, array);
  43   }
  44 }