|
Lines 1-5
Link Here
|
| 1 |
/******************************************************************************* |
1 |
/******************************************************************************* |
| 2 |
* Copyright (c) 2005, 2008 IBM Corporation and others. |
2 |
* Copyright (c) 2005, 2009 IBM Corporation and others. |
| 3 |
* All rights reserved. This program and the accompanying materials |
3 |
* All rights reserved. This program and the accompanying materials |
| 4 |
* are made available under the terms of the Eclipse Public License v1.0 |
4 |
* are made available under the terms of the Eclipse Public License v1.0 |
| 5 |
* which accompanies this distribution, and is available at |
5 |
* which accompanies this distribution, and is available at |
|
Lines 379-392
Link Here
|
| 379 |
public void move(IFileStore destination, int options, IProgressMonitor monitor) throws CoreException; |
379 |
public void move(IFileStore destination, int options, IProgressMonitor monitor) throws CoreException; |
| 380 |
|
380 |
|
| 381 |
/** |
381 |
/** |
| 382 |
* Returns an open input stream on the contents of this file. The caller |
382 |
* Returns an open input stream on the contents of this file. The number of |
| 383 |
* is responsible for closing the provided stream when it is no longer |
383 |
* concurrently open streams depends on the implementation and can be limited. |
|
|
384 |
* The caller is responsible for closing the provided stream when it is no longer |
| 384 |
* needed. |
385 |
* needed. |
| 385 |
* <p> |
386 |
* <p> |
| 386 |
* The returned stream is not guaranteed to be buffered efficiently. When reading |
387 |
* The returned stream is not guaranteed to be buffered efficiently. When reading |
| 387 |
* large blocks of data from the stream, a <code>BufferedInputStream</code> |
388 |
* large blocks of data from the stream, a <code>BufferedInputStream</code> |
| 388 |
* wrapper should be used, or some other form of content buffering. |
389 |
* wrapper should be used, or some other form of content buffering. |
| 389 |
* </p> |
390 |
* </p> |
|
|
391 |
* <p> |
| 392 |
* It depends on the implementation how the limit of concurrently opened streams |
| 393 |
* is handled. <code>CoreException</code> may be thrown, when the limit is exceeded. |
| 394 |
* </p> |
| 390 |
* |
395 |
* |
| 391 |
* @param options bit-wise or of option flag constants (currently only {@link EFS#NONE} |
396 |
* @param options bit-wise or of option flag constants (currently only {@link EFS#NONE} |
| 392 |
* is applicable). |
397 |
* is applicable). |
|
Lines 395-420
Link Here
|
| 395 |
* @return An input stream on the contents of this file. |
400 |
* @return An input stream on the contents of this file. |
| 396 |
* @exception CoreException if this method fails. Reasons include: |
401 |
* @exception CoreException if this method fails. Reasons include: |
| 397 |
* <ul> |
402 |
* <ul> |
| 398 |
* <li> This store does not exist.</li> |
403 |
* <li>This store does not exist.</li> |
| 399 |
* <li>This store represents a directory.</li> |
404 |
* <li>This store represents a directory.</li> |
|
|
405 |
* <li>The limit of concurrently opened streams has exceeded.</li> |
| 400 |
* </ul> |
406 |
* </ul> |
| 401 |
*/ |
407 |
*/ |
| 402 |
public InputStream openInputStream(int options, IProgressMonitor monitor) throws CoreException; |
408 |
public InputStream openInputStream(int options, IProgressMonitor monitor) throws CoreException; |
| 403 |
|
409 |
|
| 404 |
/** |
410 |
/** |
| 405 |
* Returns an open output stream on the contents of this file. The caller |
411 |
* Returns an open output stream on the contents of this file. The number of |
| 406 |
* is responsible for closing the provided stream when it is no longer |
412 |
* concurrently open streams depends on implementation and can be limited. |
| 407 |
* needed. This file need not exist in the underlying file system at the |
413 |
* The caller is responsible for closing the provided stream when it is no longer |
|
|
414 |
* needed. This file need not exist in the underlying file system at the |
| 408 |
* time this method is called. |
415 |
* time this method is called. |
| 409 |
* <p> |
416 |
* <p> |
| 410 |
* The returned stream is not guaranteed to be buffered efficiently. When writing |
417 |
* The returned stream is not guaranteed to be buffered efficiently. When writing |
| 411 |
* large blocks of data to the stream, a <code>BufferedOutputStream</code> |
418 |
* large blocks of data to the stream, a <code>BufferedOutputStream</code> |
| 412 |
* wrapper should be used, or some other form of content buffering. |
419 |
* wrapper should be used, or some other form of content buffering. |
| 413 |
* </p> |
420 |
* </p> |
| 414 |
* <p> |
421 |
* <p> |
|
|
422 |
* It depends on the implementation how the limit of concurrently opened streams |
| 423 |
* is handled. <code>CoreException</code> may be thrown, when the limit is exceeded. |
| 424 |
* </p> |
| 425 |
* <p> |
| 415 |
* The {@link EFS#APPEND} update flag controls where |
426 |
* The {@link EFS#APPEND} update flag controls where |
| 416 |
* output is written to the file. If this flag is specified, content written |
427 |
* output is written to the file. If this flag is specified, content written |
| 417 |
* to the stream will be appended to the end of the file. If this flag is |
428 |
* to the stream will be appended to the end of the file. If this flag is |
| 418 |
* not specified, the contents of the existing file, if any, is truncated to zero |
429 |
* not specified, the contents of the existing file, if any, is truncated to zero |
| 419 |
* and the new output will be written from the start of the file. |
430 |
* and the new output will be written from the start of the file. |
| 420 |
* </p> |
431 |
* </p> |
|
Lines 428-433
Link Here
|
| 428 |
* <ul> |
439 |
* <ul> |
| 429 |
* <li>This store represents a directory.</li> |
440 |
* <li>This store represents a directory.</li> |
| 430 |
* <li>The parent of this store does not exist.</li> |
441 |
* <li>The parent of this store does not exist.</li> |
|
|
442 |
* <li>The limit of concurrently opened streams has exceeded.</li> |
| 431 |
* </ul> |
443 |
* </ul> |
| 432 |
*/ |
444 |
*/ |
| 433 |
public OutputStream openOutputStream(int options, IProgressMonitor monitor) throws CoreException; |
445 |
public OutputStream openOutputStream(int options, IProgressMonitor monitor) throws CoreException; |
