/*
 Copyright (c) 2007 Eric J. Feminella <eric@ericfeminella.com>
 All rights reserved.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is furnished
 to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 @internal
 */

package com.ericfeminella.filesystem
{
    import flash.filesystem.File;
    import flash.filesystem.FileStream;

    /**
     *
     * Defines the contract for classes which must provide an
     * API which allows detailed inspection of an API consisting
     * of a "has-a" compositional relationship in which both the
     * underlying <code>File</code> and <code>FileStream</code>
     * object and state must be exposed
     *
     * @see flash.filesystem.File
     * @see flash.filesystem.FileStream
     *
     */
    public interface IInspectableFileClient
    {
        /**
         *
         * Returns a reference to the current File object
         *
         * @return File object resource bundle reference
         *
         */
        function get file() : File;

        /**
         *
         * Returns a reference to the current FileStream object
         *
         * @return File object resource bundle reference
         *
         */
        function get fileStream() : FileStream;

        /**
         *
         * Returns the size of the current File object
         *
         * @return the bytes available in the stream
         *
         */
        function get size() : Number;


        /**
         *
         * Closes the filestream for which has been opened
         * by the file object
         *
         */
        function close() : void;
    }
}