/*
 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
{
    /**
     * 
     * Defines the contract for classes which must provide
     * an API for writing properties to a resource bundle
     * 
     */    
    public interface IResourceWriter
    {
        /**
         * 
         * 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
         * 
         */        
        function writeBoolean(name:String, value:Boolean) : void

        /**
         * 
         * 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
         * 
         */
        function writeNumber(name:String, value:Number) : void
        
        /**
         * 
         * 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
         * 
         */
        function writeString(name:String, value:String) : void

        /**
         * 
         * 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
         * 
         */
        function writeStringArray(name:String, value:Array) : void

        /**
         * 
         * 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
         * 
         */
        function writeComment(comment:String) : void
    }
}