org.ballerinalang.nativeimpl.io.channels.base

Class CharacterChannel

java.lang.Object

org.ballerinalang.nativeimpl.io.channels.base.CharacterChannel

public class CharacterChannel
extends Object

Represents the channel to perform character I/O operations.

This is a stateful channel.

Constructor Summary

Constructors

Constructor and Description
CharacterChannel(Channel channel, String encoding)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the given channel.
String	read(int numberOfCharacters) Read asynchronously from channel.
String	readAll() Deprecated.
String	readAllChars(int nBytes) Reads all characters to the provided number of bytes.
int	write(String content, int offset) Writes a given string input into the channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterChannel

public CharacterChannel(Channel channel,
                        String encoding)

Method Detail

read

public String read(int numberOfCharacters)
            throws IOException

Read asynchronously from channel.

Parameters:

numberOfCharacters - number of characters which needs to be read.

Returns:

characters which were read.

Throws:

IOException - during I/O error.

readAllChars

public String readAllChars(int nBytes)
                    throws IOException

Reads all characters to the provided number of bytes.

Parameters:

nBytes - number of bytes.

Returns:

the character decoded for the specified byte length.

Throws:

IOException

readAll

@Deprecated
public String readAll()
                           throws IOException

Deprecated.

Reads all content from the I/O source.

Returns:

all content which is read.

Throws:

IOException - during I/O error.

write

public int write(String content,
                 int offset)
          throws IOException

Writes a given string input into the channel.

Parameters:

content - the string content to be written.

offset - the offset which should be used for writing.

Returns:

the number of bytes/characters written.

Throws:

IOException - during I/O error.

close

public void close()
           throws IOException

Closes the given channel.

Throws:

IOException - errors occur while trying to close the connection.