elogger API
Overview Classes Cluster Class Index          Top Features

kernel.io

Class KI_TEXT_OUTPUT_STREAM


Direct ancestors

KI_CHARACTER_OUTPUT_STREAM

Known direct descendants

KI_TEXT_OUTPUT_FILE, UC_STRING, KL_NULL_TEXT_OUTPUT_STREAM, KL_STDOUT_FILE, KL_STDERR_FILE, KL_STRING_OUTPUT_STREAM

Features

Invariants

indexing

description

Interface for character output streams with the notion of lines

library

Gobo Eiffel Kernel Library

copyright

Copyright (c) 2001, Eric Bezault and others

license

Eiffel Forum License v2 (see forum.txt)

deferred class KI_TEXT_OUTPUT_STREAM

inherit

KI_CHARACTER_OUTPUT_STREAM
KI_OUTPUT_STREAM [CHARACTER]

feature -- Access

name: STRING

-- Name of output stream
-- (From KI_OUTPUT_STREAM)

deferred

ensure

name_not_void: Result /= Void

eol: STRING

-- Line separator

deferred

ensure

eol_not_void: Result /= Void
eol_not_empty: Result.count > 0

feature -- Status report

is_closable: BOOLEAN

-- Can current output stream be closed?
-- (From KI_OUTPUT_STREAM)

ensure

is_open: Result implies is_open_write

is_open_write: BOOLEAN

-- Can items be written to output stream?
-- (From KI_OUTPUT_STREAM)

deferred

feature -- Basic operations

close

-- Try to close output stream if it is closable. Set
-- is_open_write to false if operation was successful.
-- (From KI_OUTPUT_STREAM)

require

is_closable: is_closable

flush

-- Flush buffered data to disk.
-- (From KI_CHARACTER_OUTPUT_STREAM)

require

is_open_write: is_open_write
deferred

feature -- Output

put_character (v: CHARACTER)

-- Write v to output stream.
-- (From KI_OUTPUT_STREAM)

require

is_open_write: is_open_write
deferred

append (an_input_stream: KI_INPUT_STREAM[CHARACTER])

-- Read items of an_input_stream until the end
-- of input is reached, and write these items to
-- current output stream.
-- (From KI_OUTPUT_STREAM)

require

is_open_write: is_open_write
an_input_stream_not_void: an_input_stream /= Void
an_input_stream_open_read: an_input_stream.is_open_read

ensure

end_of_input: an_input_stream.end_of_input

put_boolean (b: BOOLEAN)

-- Write "True" to output stream if
-- b is true, "False" otherwise.
-- (From KI_CHARACTER_OUTPUT_STREAM)

require

is_open_write: is_open_write

put_integer (i: INTEGER)

-- Write decimal representation
-- of i to output stream.
-- Regexp: 0|(-?[1-9][0-9]*)
-- (From KI_CHARACTER_OUTPUT_STREAM)

require

is_open_write: is_open_write

put_string (a_string: STRING)

-- Write a_string to output stream.
-- (From KI_CHARACTER_OUTPUT_STREAM)

require

is_open_write: is_open_write
a_string_not_void: a_string /= Void
deferred

put_substring (a_string: STRING; s, e: INTEGER)

-- Write substring of a_string between indexes
-- s and e to output stream.
-- (From KI_CHARACTER_OUTPUT_STREAM)

require

is_open_write: is_open_write
a_string_not_void: a_string /= Void
s_large_enough: s >= 1
e_small_enough: e <= a_string.count
valid_interval: s <= e + 1

put_line (a_string: STRING)

-- Write a_string to output stream
-- followed by a line separator.

require

is_open_write: is_open_write
a_string_not_void: a_string /= Void

put_new_line

-- Write a line separator to output stream.

require

is_open_write: is_open_write

invariant


-- From ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)

Documentation generated by edoc