net.sourceforge.javadpkg.io.FileMode Maven / Gradle / Ivy
Show all versions of dpkg Show documentation
/*
* dpkg - Debian Package library and the Debian Package Maven plugin
* (c) Copyright 2016 Gerrit Hohl
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package net.sourceforge.javadpkg.io;
/**
*
* The mode of a file.
*
*
* @author Gerrit Hohl ([email protected])
* @version 1.0, 12.05.2016 by Gerrit Hohl
*/
public interface FileMode {
/**
*
* Returns the mode as number including the "sticky bit".
*
*
* @return The mode.
*/
int getMode();
/**
*
* Returns the mode as an octal number excluding the "sticky bit".
*
*
* The returned value may look like this:
* 777
or like this:
* 000
*
*
* @return The mode.
*/
String getOctal();
/**
*
* Returns the mode as textual representation excluding the "sticky
* bit".
*
*
* The returned value may look like this:
* rwxrwxrwx
or like this:
* ---------
*
*
* @return The mode.
*/
String getText();
/**
*
* Returns the sticky bit.
*
*
* See
* Changing permission behavior with setuid, setgid, and sticky bits for
* more information.
*
*
* @return The sticky bit: A number from octal 0 (decimal: 0) to octal 7
* (decimal: 7).
*/
int getStickyBit();
/**
*
* Returns the flag if the owner can read the file.
*
*
* @return The flag: true, if the owner can, false
* otherwise.
*/
boolean isOwnerReadable();
/**
*
* Returns the flag if the owner can write the file.
*
*
* @return The flag: true, if the owner can, false
* otherwise.
*/
boolean isOwnerWriteable();
/**
*
* Returns the flag if the owner can execute the file.
*
*
* @return The flag: true, if the owner can, false
* otherwise.
*/
boolean isOwnerExecutable();
/**
*
* Returns the flag if the group can read the file.
*
*
* @return The flag: true, if the group can, false
* otherwise.
*/
boolean isGroupReadable();
/**
*
* Returns the flag if the group can write the file.
*
*
* @return The flag: true, if the group can, false
* otherwise.
*/
boolean isGroupWriteable();
/**
*
* Returns the flag if the group can execute the file.
*
*
* @return The flag: true, if the group can, false
* otherwise.
*/
boolean isGroupExecutable();
/**
*
* Returns the flag if the others can read the file.
*
*
* @return The flag: true, if the others can,
* false otherwise.
*/
boolean isOtherReadable();
/**
*
* Returns the flag if the others can write the file.
*
*
* @return The flag: true, if the others can,
* false otherwise.
*/
boolean isOtherWriteable();
/**
*
* Returns the flag if the others can execute the file.
*
*
* @return The flag: true, if the others can,
* false otherwise.
*/
boolean isOtherExecutable();
}