diff options
Diffstat (limited to 'org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java')
| -rw-r--r-- | org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java | 293 |
1 files changed, 0 insertions, 293 deletions
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java deleted file mode 100644 index 883332866..000000000 --- a/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java +++ /dev/null @@ -1,293 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2008 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * IBM Corporation - initial API and implementation - * Remy Chi Jian Suen <remy.suen@gmail.com> - Bug 214424 IOConsole(String, String, ImageDescriptor, String, boolean) constructor is missing api javadoc - *******************************************************************************/ - -package org.eclipse.ui.console; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - -import org.eclipse.jface.resource.ImageDescriptor; -import org.eclipse.ui.WorkbenchEncoding; -import org.eclipse.ui.internal.console.IOConsolePage; -import org.eclipse.ui.internal.console.IOConsolePartitioner; -import org.eclipse.ui.part.IPageBookViewPage; - -/** - * A console that displays text from I/O streams. An I/O console can have multiple - * output streams connected to it and provides one input stream connected to the - * keyboard. - * <p> - * Clients may instantiate and subclass this class. - * </p> - * @since 3.1 - */ -public class IOConsole extends TextConsole { - /** - * The document partitioner - */ - private IOConsolePartitioner partitioner; - - /** - * The stream from which user input may be read - */ - private IOConsoleInputStream inputStream; - - /** - * A collection of open streams connected to this console. - */ - private List openStreams; - - /** - * The encoding used to for displaying console output. - */ - private String fEncoding = WorkbenchEncoding.getWorkbenchDefaultEncoding(); - - - /** - * Constructs a console with the given name, type, image, and lifecycle, with the - * workbench's default encoding. - * - * @param name name to display for this console - * @param consoleType console type identifier or <code>null</code> - * @param imageDescriptor image to display for this console or <code>null</code> - * @param autoLifecycle whether lifecycle methods should be called automatically - * when this console is added/removed from the console manager - */ - public IOConsole(String name, String consoleType, ImageDescriptor imageDescriptor, boolean autoLifecycle) { - this(name, consoleType, imageDescriptor, null, autoLifecycle); - } - - /** - * Constructs a console with the given name, type, image, encoding and lifecycle. - * - * @param name name to display for this console - * @param consoleType console type identifier or <code>null</code> - * @param imageDescriptor image to display for this console or <code>null</code> - * @param encoding the encoding that should be used to render the text, or <code>null</code> - * if the system default encoding should be used - * @param autoLifecycle whether lifecycle methods should be called automatically - * when this console is added/removed from the console manager - */ - public IOConsole(String name, String consoleType, ImageDescriptor imageDescriptor, String encoding, boolean autoLifecycle) { - super(name, consoleType, imageDescriptor, autoLifecycle); - if (encoding != null) { - fEncoding = encoding; - } - openStreams = new ArrayList(); - inputStream = new IOConsoleInputStream(this); - synchronized (openStreams) { - openStreams.add(inputStream); - } - - partitioner = new IOConsolePartitioner(inputStream, this); - partitioner.connect(getDocument()); - } - - /** - * Constructs a console with the given name, type, and image with the workbench's - * default encoding. Lifecycle methods will be called when this console is - * added/removed from the console manager. - * - * @param name name to display for this console - * @param consoleType console type identifier or <code>null</code> - * @param imageDescriptor image to display for this console or <code>null</code> - */ - public IOConsole(String name, String consoleType, ImageDescriptor imageDescriptor) { - this(name, consoleType, imageDescriptor, true); - } - - /** - * Constructs a console with the given name and image. Lifecycle methods - * will be called when this console is added/removed from the console manager. - * This console will have an unspecified (<code>null</code>) type. - * - * @param name name to display for this console - * @param imageDescriptor image to display for this console or <code>null</code> - */ - public IOConsole(String name, ImageDescriptor imageDescriptor) { - this(name, null, imageDescriptor); - } - - /* (non-Javadoc) - * @see org.eclipse.ui.console.IConsole#createPage(org.eclipse.ui.console.IConsoleView) - */ - public IPageBookViewPage createPage(IConsoleView view) { - return new IOConsolePage(this, view); - } - - /** - * Creates and returns a new output stream which may be used to write to this console. - * A console may be connected to more than one output stream at once. Clients are - * responsible for closing any output streams created on this console. - * <p> - * Clients should avoid writing large amounts of output to this stream in the UI - * thread. The console needs to process the output in the UI thread and if the client - * hogs the UI thread writing output to the console, the console will not be able - * to process the output. - * </p> - * @return a new output stream connected to this console - */ - public IOConsoleOutputStream newOutputStream() { - IOConsoleOutputStream outputStream = new IOConsoleOutputStream(this); - outputStream.setEncoding(fEncoding); - synchronized(openStreams) { - openStreams.add(outputStream); - } - return outputStream; - } - - /** - * Returns the input stream connected to the keyboard. - * - * @return the input stream connected to the keyboard. - */ - public IOConsoleInputStream getInputStream() { - return inputStream; - } - - /** - * Returns this console's document partitioner. - * - * @return this console's document partitioner - */ - protected IConsoleDocumentPartitioner getPartitioner() { - return partitioner; - } - - /** - * Returns the maximum number of characters that the console will display at - * once. This is analogous to the size of the text buffer this console - * maintains. - * - * @return the maximum number of characters that the console will display - */ - public int getHighWaterMark() { - return partitioner.getHighWaterMark(); - } - - /** - * Returns the number of characters that will remain in this console - * when its high water mark is exceeded. - * - * @return the number of characters that will remain in this console - * when its high water mark is exceeded - */ - public int getLowWaterMark() { - return partitioner.getLowWaterMark(); - } - - /** - * Sets the text buffer size for this console. The high water mark indicates - * the maximum number of characters stored in the buffer. The low water mark - * indicates the number of characters remaining in the buffer when the high - * water mark is exceeded. - * - * @param low the number of characters remaining in the buffer when the high - * water mark is exceeded (if -1 the console does not limit output) - * @param high the maximum number of characters this console will cache in - * its text buffer (if -1 the console does not limit output) - * @exception IllegalArgumentException if low >= high & low != -1 - */ - public void setWaterMarks(int low, int high) { - if (low >= 0) { - if (low >= high) { - throw new IllegalArgumentException("High water mark must be greater than low water mark"); //$NON-NLS-1$ - } - } - partitioner.setWaterMarks(low, high); - } - - /** - * Check if all streams connected to this console are closed. If so, - * notify the partitioner that this console is finished. - */ - private void checkFinished() { - if (openStreams.isEmpty()) { - partitioner.streamsClosed(); - } - } - - /** - * Notification that an output stream connected to this console has been closed. - * - * @param stream stream that closed - */ - void streamClosed(IOConsoleOutputStream stream) { - synchronized (openStreams) { - openStreams.remove(stream); - checkFinished(); - } - } - - /** - * Notification that the input stream connected to this console has been closed. - * - * @param stream stream that closed - */ - void streamClosed(IOConsoleInputStream stream) { - synchronized (openStreams) { - openStreams.remove(stream); - checkFinished(); - } - } - - /* (non-Javadoc) - * @see org.eclipse.ui.console.TextConsole#clearConsole() - */ - public void clearConsole() { - if (partitioner != null) { - partitioner.clearBuffer(); - } - } - - /** - * Disposes this console. - */ - protected void dispose() { - super.dispose(); - partitioner.disconnect(); - //make a copy of the open streams and close them all - //a copy is needed as close the streams results in a callback that - //removes the streams from the openStreams collection (bug 152794) - Object[] allStreams= openStreams.toArray(); - for (int i = 0; i < allStreams.length; i++) { - Object stream = allStreams[i]; - if (stream instanceof IOConsoleInputStream) { - IOConsoleInputStream is = (IOConsoleInputStream) stream; - try { - is.close(); - } catch (IOException e) { - } - } else if (stream instanceof IOConsoleOutputStream) { - IOConsoleOutputStream os = (IOConsoleOutputStream) stream; - try { - os.close(); - } catch (IOException e) { - } - } - } - inputStream = null; - } - - /** - * Returns the encoding for this console, or <code>null</code> to indicate - * default encoding. - * - * @return the encoding set for this console, or <code>null</code> to indicate - * default encoding - * @since 3.3 - */ - public String getEncoding() { - return fEncoding; - } -} |