src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.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.commons.compress.archivers.cpio;

/**
 * All constants needed by CPIO.
 * 
 * based on code from the jRPM project (jrpm.sourceforge.net) 
 */
public interface CpioConstants {
    /** magic number of a cpio entry in the new format */
    final String MAGIC_NEW = "070701";

    /** magic number of a cpio entry in the new format with crc */
    final String MAGIC_NEW_CRC = "070702";

    /** magic number of a cpio entry in the old ascii format */
    final String MAGIC_OLD_ASCII = "070707";

    /** magic number of a cpio entry in the old binary format */
    final int MAGIC_OLD_BINARY = 070707;

    /** write/read a CPIOArchiveEntry in the new format */
    final short FORMAT_NEW = 1;

    /** write/read a CPIOArchiveEntry in the new format with crc */
    final short FORMAT_NEW_CRC = 2;

    /** write/read a CPIOArchiveEntry in the old ascii format */
    final short FORMAT_OLD_ASCII = 4;

    /** write/read a CPIOArchiveEntry in the old binary format */
    final short FORMAT_OLD_BINARY = 8;

    /** Mask for both new formats */
    final short FORMAT_NEW_MASK = 3;

    /** Mask for both old formats */
    final short FORMAT_OLD_MASK = 12;

    /** Mask for all file type bits. */
    final int S_IFMT = 0170000;

    /** Defines a directory */
    final int C_ISDIR = 0040000;

    /** Defines a symbolic link */
    final int C_ISLNK = 0120000;

    /** Defines a regular file */
    final int C_ISREG = 0100000;

    /** Defines a pipe */
    final int C_ISFIFO = 0010000;

    /** Defines a character device */
    final int C_ISCHR = 0020000;

    /** Defines a block device */
    final int C_ISBLK = 0060000;

    /** Defines a socket */
    final int C_ISSOCK = 0140000;

    /** HP/UX network special (C_ISCTG) */
    final int C_ISNWK = 0110000;

    /** Permits the owner of a file to read the file */
    final int C_IRUSR = 000400;

    /** Permits the owner of a file to write to the file */
    final int C_IWUSR = 000200;

    /**
     * Permits the owner of a file to execute the file or to search the file's
     * directory
     */
    final int C_IXUSR = 000100;

    /** Permits a file's group to read the file */
    final int C_IRGRP = 000040;

    /** Permits a file's group to write to the file */
    final int C_IWGRP = 000020;

    /**
     * Permits a file's group to execute the file or to search the file's
     * directory
     */
    final int C_IXGRP = 000010;

    /** Permits others to read the file */
    final int C_IROTH = 000004;

    /** Permits others to write to the file */
    final int C_IWOTH = 000002;

    /** Permits others to execute the file or to search the file's directory */
    final int C_IXOTH = 000001;

    /** TODO document */
    final int C_ISUID = 004000;

    /** TODO document */
    final int C_ISGID = 002000;

    /** TODO document */
    final int C_ISVTX = 001000;
}