Home | History | Annotate | Download | only in io
      1 /*
      2  * Copyright (C) 2008 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package com.android.io;
     18 
     19 import java.io.InputStream;
     20 import java.io.OutputStream;
     21 
     22 /**
     23  * A file.
     24  */
     25 public interface IAbstractFile extends IAbstractResource {
     26     public static enum PreferredWriteMode {
     27         INPUTSTREAM, OUTPUTSTREAM;
     28     }
     29 
     30     /**
     31      * Returns an {@link InputStream} object on the file content.
     32      * @throws StreamException
     33      */
     34     InputStream getContents() throws StreamException;
     35 
     36     /**
     37      * Sets the content of the file.
     38      * @param source the content
     39      * @throws StreamException
     40      */
     41     void setContents(InputStream source) throws StreamException;
     42 
     43     /**
     44      * Returns an {@link OutputStream} to write into the file.
     45      * @throws StreamException
     46      */
     47     OutputStream getOutputStream() throws StreamException;
     48 
     49     /**
     50      * Returns the preferred mode to write into the file.
     51      */
     52     PreferredWriteMode getPreferredWriteMode();
     53 
     54     /**
     55      * Returns the last modification timestamp
     56      */
     57     long getModificationStamp();
     58 }
     59