java.lang.Object
- net.sourceforge.plantuml.security.SFile

All Implemented Interfaces:

Comparable<SFile>
```
public class SFile
extends Object
implements Comparable<SFile>
```
Secure replacement for java.io.File.
This class should be used instead of java.io.File. There are few exceptions (mainly in the Swing part and in the ANT task)
This class does some control access and in secure mode hide the real path of file, so that it cannot be printed to end users.

Field Summary

Fields
Modifier and Type Field Description

static String pathSeparator

static String separator

static char separatorChar

Constructor Summary

Constructors
Constructor Description

SFile(String nameOrPath)

SFile(String dirname, String name)

SFile(URI uri)

SFile(SFile basedir, String name)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canRead()`
`boolean`	`canWrite()`
`int`	`compareTo(SFile other)`
`File`	`conv()`
`BufferedOutputStream`	`createBufferedOutputStream()`
`FileOutputStream`	`createFileOutputStream()`
`FileOutputStream`	`createFileOutputStream(boolean append)`
`PrintStream`	`createPrintStream()`
`PrintStream`	`createPrintStream(String charset)`
`PrintStream`	`createPrintStream(Charset charset)`
`PrintWriter`	`createPrintWriter()`
`PrintWriter`	`createPrintWriter(String charset)`
`static SFile`	`createTempFile(String prefix, String suffix)`
`void`	`delete()`
`void`	`deleteOnExit()`
`boolean`	`equals(Object obj)`
`boolean`	`exists()`
`SFile`	`file(String name)`
`static SFile`	`fromFile(File internal)`
`SFile`	`getAbsoluteFile()`
`String`	`getAbsolutePath()`
`static BufferedImage`	`getBufferedImageFromWebpButHeader(InputStream is)`
`SFile`	`getCanonicalFile()`
`String`	`getName()`
`SFile`	`getParentFile()`
`String`	`getPath()`
`String`	`getPrintablePath()`
`int`	`hashCode()`
`boolean`	`isAbsolute()`
`boolean`	`isDirectory()`
`boolean`	`isFile()`
`long`	`lastModified()`
`long`	`length()`
`String[]`	`list()`
`Collection<SFile>`	`listFiles()`
`void`	`mkdirs()`
`BufferedReader`	`openBufferedReader()`
`InputStream`	`openFile()`
`BufferedImage`	`readRasterImageFromFile()`
`boolean`	`renameTo(SFile dest)`
`void`	`setWritable(boolean b)`
`String`	`toString()`
`URI`	`toURI()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

separator
```
public static String separator
```

pathSeparator
```
public static String pathSeparator
```

separatorChar
```
public static char separatorChar
```

Constructor Detail

SFile
```
public SFile(String nameOrPath)
```

SFile

public SFile(String dirname,
             String name)

SFile

public SFile(SFile basedir,
             String name)

SFile
```
public SFile(URI uri)
```

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

fromFile

public static SFile fromFile(File internal)

file
```
public SFile file(String name)
```

exists
```
public boolean exists()
```

getCanonicalFile

public SFile getCanonicalFile()
                       throws IOException

Throws:: IOException

isAbsolute
```
public boolean isAbsolute()
```

isDirectory
```
public boolean isDirectory()
```

getName
```
public String getName()
```

isFile
```
public boolean isFile()
```

lastModified
```
public long lastModified()
```

compareTo
```
public int compareTo(SFile other)
```
Specified by:

compareTo in interface Comparable<SFile>

getPath
```
public String getPath()
```

length
```
public long length()
```

canWrite
```
public boolean canWrite()
```

setWritable

public void setWritable(boolean b)

delete
```
public void delete()
```

listFiles
```
public Collection<SFile> listFiles()
```

list
```
public String[] list()
```

getAbsoluteFile
```
public SFile getAbsoluteFile()
```

getParentFile
```
public SFile getParentFile()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

getAbsolutePath
```
public String getAbsolutePath()
```

getPrintablePath
```
public String getPrintablePath()
```

canRead
```
public boolean canRead()
```

deleteOnExit
```
public void deleteOnExit()
```

mkdirs
```
public void mkdirs()
```

createTempFile

public static SFile createTempFile(String prefix,
                                   String suffix)
                            throws IOException

Throws:: IOException

toURI
```
public URI toURI()
```

renameTo

public boolean renameTo(SFile dest)

readRasterImageFromFile

public BufferedImage readRasterImageFromFile()

getBufferedImageFromWebpButHeader

public static BufferedImage getBufferedImageFromWebpButHeader(InputStream is)

openBufferedReader

public BufferedReader openBufferedReader()

conv
```
public File conv()
```

openFile
```
public InputStream openFile()
```

createBufferedOutputStream

public BufferedOutputStream createBufferedOutputStream()
                                                throws FileNotFoundException

Throws:: FileNotFoundException

createPrintWriter

public PrintWriter createPrintWriter()
                              throws FileNotFoundException

Throws:: FileNotFoundException

createPrintWriter

public PrintWriter createPrintWriter(String charset)
                              throws FileNotFoundException,
                                     UnsupportedEncodingException

Throws:: FileNotFoundException; UnsupportedEncodingException

createFileOutputStream

public FileOutputStream createFileOutputStream()
                                        throws FileNotFoundException

Throws:: FileNotFoundException

createFileOutputStream

public FileOutputStream createFileOutputStream(boolean append)
                                        throws FileNotFoundException

Throws:: FileNotFoundException

createPrintStream

public PrintStream createPrintStream()
                              throws FileNotFoundException

Throws:: FileNotFoundException

createPrintStream

public PrintStream createPrintStream(String charset)
                              throws FileNotFoundException,
                                     UnsupportedEncodingException

Throws:: FileNotFoundException; UnsupportedEncodingException

createPrintStream

public PrintStream createPrintStream(Charset charset)
                              throws FileNotFoundException,
                                     UnsupportedEncodingException

Throws:: FileNotFoundException; UnsupportedEncodingException

Modifier and Type	Field	Description
`static String`	`pathSeparator`
`static String`	`separator`
`static char`	`separatorChar`

Constructor	Description
`SFile(String nameOrPath)`
`SFile(String dirname, String name)`
`SFile(URI uri)`
`SFile(SFile basedir, String name)`

Class SFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

separator

pathSeparator

separatorChar

Constructor Detail

SFile

SFile

SFile

SFile

Method Detail

toString

fromFile

file

exists

getCanonicalFile

isAbsolute

isDirectory

getName

isFile

lastModified

compareTo

getPath

length

canWrite

setWritable

delete

listFiles

list

getAbsoluteFile

getParentFile

hashCode

equals

getAbsolutePath

getPrintablePath

canRead

deleteOnExit

mkdirs

createTempFile

toURI

renameTo

readRasterImageFromFile

getBufferedImageFromWebpButHeader

openBufferedReader

conv

openFile

createBufferedOutputStream

createPrintWriter

createPrintWriter

createFileOutputStream

createFileOutputStream

createPrintStream

createPrintStream

createPrintStream