Class ResourceAttributes
- java.lang.Object
-
- org.eclipse.core.resources.ResourceAttributes
-
public class ResourceAttributes extends Object
This class represents platform specific attributes of files. Any attributes can be added, but only the attributes that are supported by the platform will be used. These methods do not set the attributes in the file system.- Since:
- 3.1
- See Also:
IResource.getResourceAttributes(),IResource.setResourceAttributes(ResourceAttributes)- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Constructor Summary
Constructors Constructor Description ResourceAttributes()Creates a new instance ofResourceAttributes.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResourceAttributesfromFile(File file)Creates a new resource attributes instance with attributes taken from the specified file in the file system.booleanisArchive()Returns whether this ResourceAttributes object is marked archive.booleanisExecutable()Returns whether this ResourceAttributes object is marked executable.booleanisHidden()Returns whether this ResourceAttributes object is marked hidden.booleanisReadOnly()Returns whether this ResourceAttributes object is marked read only.booleanisSet(int mask)Returns whether this ResourceAttributes object has the given mask set.booleanisSymbolicLink()Returns whether this ResourceAttributes object is marked as symbolic link.voidset(int mask, boolean value)Clears all of the bits indicated by the mask.voidsetArchive(boolean archive)Sets or unsets whether this ResourceAttributes object is marked archive.voidsetExecutable(boolean executable)Sets or unsets whether this ResourceAttributes object is marked executable.voidsetHidden(boolean hidden)Sets or unsets whether this ResourceAttributes object is marked hiddenvoidsetReadOnly(boolean readOnly)Sets or unsets whether this ResourceAttributes object is marked read only.voidsetSymbolicLink(boolean symLink)Sets or unsets whether this ResourceAttributes object is marked as symbolic link.StringtoString()Returns a string representation of the attributes, suitable for debugging purposes only.
-
-
-
Method Detail
-
fromFile
public static ResourceAttributes fromFile(File file)
Creates a new resource attributes instance with attributes taken from the specified file in the file system. If the specified file does not exist or is not accessible, this method has the same effect as calling the default constructor.- Parameters:
file- The file to get attributes from- Returns:
- A resource attributes object
-
isArchive
public boolean isArchive()
Returns whether this ResourceAttributes object is marked archive.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_ARCHIVE.- Returns:
trueif this resource is marked archive,falseotherwise- See Also:
setArchive(boolean),IFileSystem.attributes(),EFS.ATTRIBUTE_ARCHIVE
-
isExecutable
public boolean isExecutable()
Returns whether this ResourceAttributes object is marked executable.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_EXECUTABLE.- Returns:
trueif this resource is marked executable,falseotherwise- See Also:
setExecutable(boolean),IFileSystem.attributes(),EFS.ATTRIBUTE_EXECUTABLE
-
isHidden
public boolean isHidden()
Returns whether this ResourceAttributes object is marked hidden.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_HIDDEN.- Returns:
trueif this resource is marked hidden,falseotherwise- Since:
- 3.2
- See Also:
setHidden(boolean),IFileSystem.attributes(),EFS.ATTRIBUTE_HIDDEN
-
isReadOnly
public boolean isReadOnly()
Returns whether this ResourceAttributes object is marked read only.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_READ_ONLY.- Returns:
trueif this resource is marked as read only,falseotherwise- See Also:
setReadOnly(boolean),IFileSystem.attributes(),EFS.ATTRIBUTE_READ_ONLY
-
isSymbolicLink
public boolean isSymbolicLink()
Returns whether this ResourceAttributes object is marked as symbolic link.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_SYMLINK.- Returns:
trueif this resource is marked as symbolic link,falseotherwise- Since:
- 3.4
- See Also:
setSymbolicLink(boolean),IFileSystem.attributes(),EFS.ATTRIBUTE_SYMLINK
-
setArchive
public void setArchive(boolean archive)
Sets or unsets whether this ResourceAttributes object is marked archive.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_ARCHIVE.- Parameters:
archive-trueto set it to be archive,falseto unset- See Also:
isArchive(),IFileSystem.attributes(),EFS.ATTRIBUTE_ARCHIVE
-
set
public void set(int mask, boolean value)Clears all of the bits indicated by the mask.- Restriction:
- This method is not intended to be referenced by clients.
- Restriction:
- This method is not intended to be re-implemented or extended by clients.
-
isSet
public boolean isSet(int mask)
Returns whether this ResourceAttributes object has the given mask set.- Restriction:
- This method is not intended to be referenced by clients.
- Restriction:
- This method is not intended to be re-implemented or extended by clients.
-
setExecutable
public void setExecutable(boolean executable)
Sets or unsets whether this ResourceAttributes object is marked executable.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_EXECUTABLE.- Parameters:
executable-trueto set it to be executable,falseto unset- See Also:
isExecutable(),IFileSystem.attributes(),EFS.ATTRIBUTE_EXECUTABLE
-
setHidden
public void setHidden(boolean hidden)
Sets or unsets whether this ResourceAttributes object is marked hiddenThis attribute is used only on file systems supporting
EFS.ATTRIBUTE_HIDDEN.- Parameters:
hidden-trueto set it to be marked hidden,falseto unset- Since:
- 3.2
- See Also:
isHidden(),IFileSystem.attributes(),EFS.ATTRIBUTE_HIDDEN
-
setReadOnly
public void setReadOnly(boolean readOnly)
Sets or unsets whether this ResourceAttributes object is marked read only.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_READ_ONLY.- Parameters:
readOnly-trueto set it to be marked read only,falseto unset- See Also:
isReadOnly(),IFileSystem.attributes(),EFS.ATTRIBUTE_READ_ONLY
-
setSymbolicLink
public void setSymbolicLink(boolean symLink)
Sets or unsets whether this ResourceAttributes object is marked as symbolic link.This attribute is used only on file systems supporting
EFS.ATTRIBUTE_SYMLINK.- Parameters:
symLink-trueto set it to be marked as symbolic link,falseto unset- Since:
- 3.4
- See Also:
isSymbolicLink(),IFileSystem.attributes(),EFS.ATTRIBUTE_SYMLINK
-
-