/*
 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.resources
{
    import com.ericfeminella.filesystem.IInspectableFileClient;
    import com.ericfeminella.resources.IResourceWriter;
    import flash.filesystem.File;
    import flash.filesystem.FileMode;
    import flash.filesystem.FileStream;

    /**
     * 
     * Provides an API for creating and modifying resource 
     * bundles
     * 
     */
    public class ResourceWriter implements IResourceWriter, IInspectableFileClient
    {
        /**
         * 
         * Reference to the File object for the resource bundle
         * 
         * @see flash.filesystem.File
         * 
         */
        protected var resource:File;

        /**
         * 
         * Reference to the FileStream object for the resource 
         * bundle
         * 
         * @see flash.filesystem.FileStream
         * 
         */
        protected var stream:FileStream;

        /**
         * 
         * Creates a new .properties file or references an existing
         * resource bundle for modification
         *
         * @param  the name of the .properties file to reference
         * @param  the path in which the file will resolve
         * 
         */
        public function ResourceWriter(name:String, path:String)
        {
            resource = new File();
            resource.nativePath = path + File.separator + name;

            stream = new FileStream();
            stream.open( resource, FileMode.UPDATE );
        }

        /**
         * 
         * Writes a new property of type Boolean to the file
         *
         * @param  the name or key of the property to create
         * @param  the value of the specified key
         * 
         */
        public function writeBoolean(name:String, value:Boolean) : void
        {
            createProperty( name, String(value) );
        }

        /**
         * 
         * Writes a new property of type Number to the file
         *
         * @param  the name or key of the property to create
         * @param  the value of the specified key
         * 
         */
        public function writeNumber(name:String, value:Number) : void
        {
            createProperty( name, String(value) );
        }

        /**
         * 
         * Writes a new property of type String to the file
         *
         * @param  the name or key of the property to create
         * @param  the value of the specified key
         * 
         */
        public function writeString(name:String, value:String) : void
        {
            createProperty( name, String(value) );
        }

        /**
         * 
         * Writes a new property of type StringArray to the file
         *
         * @param  the name or key of the property to create
         * @param  the value of the specified key
         * 
         */
        public function writeStringArray(name:String, value:Array) : void
        {
            createProperty( name, String(value) );
        }

        /**
         * 
         * Writes a new comment to the resource bundle
         *
         * @param  the name or key of the property to create
         * @param  the value of the specified key
         * 
         */
        public function writeComment(comment:String) : void
        {
            stream.readUTFBytes( size );
            stream.writeUTFBytes( "#" + comment + "\n" );
        }

        /**
         * 
         * Manages creating new properties to the resource
         * bundle file reference
         *
         * @param  the name or key of the property to create
         * @param  the value of the specified key
         * 
         */
        protected function createProperty(key:String, value:String) : void
        {
            stream.readUTFBytes( size );
            stream.writeUTFBytes( key + "=" + value + "\n" );
        }

        /**
         * 
         * Returns a reference to the resource bundle File object
         *
         * @return File object resource bundle reference
         * 
         */
        public function get file() : File
        {
            return resource;
        }

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

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

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