001    /*
002     *   Copyright (C) Christian Schulte, 2005-206
003     *   All rights reserved.
004     *
005     *   Redistribution and use in source and binary forms, with or without
006     *   modification, are permitted provided that the following conditions
007     *   are met:
008     *
009     *     o Redistributions of source code must retain the above copyright
010     *       notice, this list of conditions and the following disclaimer.
011     *
012     *     o Redistributions in binary form must reproduce the above copyright
013     *       notice, this list of conditions and the following disclaimer in
014     *       the documentation and/or other materials provided with the
015     *       distribution.
016     *
017     *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
018     *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
019     *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
020     *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
021     *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
022     *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
023     *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
024     *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025     *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
026     *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027     *
028     *   $JOMC: PropertiesResourceType.java 3838 2011-10-08 20:15:41Z schulte2005 $
029     *
030     */
031    package org.jomc.ant.types;
032    
033    import org.apache.commons.lang.builder.ToStringBuilder;
034    
035    /**
036     * Datatype describing a properties resource.
037     *
038     * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a>
039     * @version $JOMC: PropertiesResourceType.java 3838 2011-10-08 20:15:41Z schulte2005 $
040     */
041    public class PropertiesResourceType extends ResourceType
042    {
043    
044        /** The format of the properties resource. */
045        private PropertiesFormatType format;
046    
047        /** Creates a new {@code PropertiesResourceType} instance. */
048        public PropertiesResourceType()
049        {
050            super();
051        }
052    
053        /**
054         * Gets the value of the {@code format} property.
055         *
056         * @return The value of the {@code format} property.
057         *
058         * @see #setFormat(org.jomc.ant.types.PropertiesFormatType)
059         */
060        public final PropertiesFormatType getFormat()
061        {
062            if ( this.format == null )
063            {
064                this.format = PropertiesFormatType.PLAIN;
065            }
066    
067            return this.format;
068        }
069    
070        /**
071         * Sets the value of the {@code format} property.
072         *
073         * @param value The new value of the {@code format} property or {@code null}.
074         *
075         * @see #getFormat()
076         */
077        public final void setFormat( final PropertiesFormatType value )
078        {
079            this.format = value;
080        }
081    
082        /**
083         * Creates and returns a copy of this object.
084         *
085         * @return A copy of this object.
086         */
087        @Override
088        public PropertiesResourceType clone()
089        {
090            return (PropertiesResourceType) super.clone();
091        }
092    
093        /**
094         * Creates and returns a string representation of the object.
095         *
096         * @return A string representation of the object.
097         */
098        @Override
099        public String toString()
100        {
101            return ToStringBuilder.reflectionToString( this );
102        }
103    
104    }