org.vishia.util

Class FileWriter

java.lang.Object

java.io.Writer

org.vishia.util.FileWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

Deprecated.

use instead FileAppend

@Deprecated
public class FileWriter
extends java.io.Writer

This class is a alternative to java.io.FileWriter. It based on java.util.OutputStreamWriter, adequate to java.io.FileWriter. But in opposite to that,

• The instance of this class will be preserved also if the file is closed, respectively the instance can be created static, without opened file. It is because usage in fast realtime systems in C via Java2C-translator. The implementation in C is written without any dynamically memory.
• On open() no exceptions are thrown, a boolean return value is used.

Field Summary

Fields

Modifier and Type	Field and Description
static int	kFileNotFound Deprecated.
static int	kFileOpenError Deprecated.
java.lang.String	sError Deprecated.
static java.lang.String	sVersion Deprecated. Version, history and license.
protected java.io.OutputStreamWriter	writer Deprecated. The OutputStreamWriter can't be used as superclass, because the file is able to open only with calling constructor.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
FileWriter() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
void	finalize() Deprecated.
void	flush() Deprecated.
boolean	isOpen() Deprecated.
int	open(java.lang.String fileName, boolean append) Deprecated. opens a file to write.
int	open(java.lang.String fileName, java.lang.String sEncoding, boolean append) Deprecated. opens a file to write.
void	write(char[] cbuf, int off, int len) Deprecated.
void	write(java.lang.String text) Deprecated.

Methods inherited from class java.io.Writer

append, append, append, write, write, write

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sVersion

public static final java.lang.String sVersion

Deprecated.

Version, history and license. Changes:

• 2022-01-17 Hartmut new: open(String, String, boolean) with specific encoding.
• 2011 Hartmut: created

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

writer

protected java.io.OutputStreamWriter writer

Deprecated.

The OutputStreamWriter can't be used as superclass, because the file is able to open only with calling constructor. Thats why all methods of OutputStreamWriter have to be wrapped here.

kFileNotFound

public static final int kFileNotFound

Deprecated.

See Also:

Constant Field Values

kFileOpenError

public static final int kFileOpenError

Deprecated.

See Also:

Constant Field Values

sError

public java.lang.String sError

Deprecated.

Constructor Detail

FileWriter

public FileWriter()

Deprecated.

Method Detail

open

public int open(java.lang.String fileName,
                boolean append)

Deprecated.

opens a file to write.

Parameters:

fileName - Path to the file. To separate folder, a slash '/' should be used. But a backslash is also accepted. An absolute path should be start either with slash or with a one-char drive specifier, following by ':/'.

append - If the file exists, the content written than is appended.

Returns:

0 if the file is opened, -1 if the file is not found, -2 on other conditions.

open

public int open(java.lang.String fileName,
                java.lang.String sEncoding,
                boolean append)

Deprecated.

opens a file to write.

Parameters:

fileName - Path to the file. To separate folder, a slash '/' should be used. But a backslash is also accepted. Can contain environment variables, can start with /tmp/ or ~ for home, see FileFunctions.absolutePath(String, java.io.File). An absolute path should be start either with slash or with a one-char drive specifier, following by ':/'.

sEncoding - character encoding for the binary file, "UTF-8" etc. see OutputStreamWriter.OutputStreamWriter(java.io.OutputStream, String)

append - If the file exists, the content written than is appended.

Returns:

0 if the file is opened, -1 if the file is not found, -2 on other conditions.

isOpen

public boolean isOpen()

Deprecated.

close

public void close()

Deprecated.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

write

public void write(java.lang.String text)
           throws java.io.IOException

Deprecated.

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Deprecated.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

finalize

public void finalize()

Deprecated.

Overrides:

finalize in class java.lang.Object

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException

Deprecated.

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException