package org.apache.commons.digester3.rss;

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.io.PrintWriter;
import java.io.Serializable;

/**
 * <p>Implementation object representing an <strong>image</strong> in the
 * <em>Rich Site Summary</em> DTD, version 0.91.  This class may be subclassed
 * to further specialize its behavior.</p>
 */
public class Image
    implements Serializable
{

    /**
     *
     */
    private static final long serialVersionUID = 7651966908064015194L;

    // ------------------------------------------------------------- Properties

    /**
     * The image description (1-100 characters).
     */
    protected String description = null;

    public String getDescription()
    {
        return ( this.description );
    }

    public void setDescription( final String description )
    {
        this.description = description;
    }

    /**
     * The image height in pixels (1-400).
     */
    protected int height = 31;

    public int getHeight()
    {
        return ( this.height );
    }

    public void setHeight( final int height )
    {
        this.height = height;
    }

    /**
     * The image link (1-500 characters).
     */
    protected String link = null;

    public String getLink()
    {
        return ( this.link );
    }

    public void setLink( final String link )
    {
        this.link = link;
    }

    /**
     * The image alternate text (1-100 characters).
     */
    protected String title = null;

    public String getTitle()
    {
        return ( this.title );
    }

    public void setTitle( final String title )
    {
        this.title = title;
    }

    /**
     * The image location URL (1-500 characters).
     */
    protected String url = null;

    public String getURL()
    {
        return ( this.url );
    }

    public void setURL( final String url )
    {
        this.url = url;
    }

    /**
     * The image width in pixels (1-400).
     */
    protected int width = 31;

    public int getWidth()
    {
        return ( this.width );
    }

    public void setWidth( final int width )
    {
        this.width = width;
    }

    // -------------------------------------------------------- Package Methods

    /**
     * Render this channel as XML conforming to the RSS 0.91 specification,
     * to the specified writer.
     *
     * @param writer The writer to render output to
     */
    void render( final PrintWriter writer )
    {
        writer.println( "    <image>" );

        writer.print( "      <title>" );
        writer.print( title );
        writer.println( "</title>" );

        writer.print( "      <url>" );
        writer.print( url );
        writer.println( "</url>" );

        if ( link != null )
        {
            writer.print( "      <link>" );
            writer.print( link );
            writer.println( "</link>" );
        }

        writer.print( "      <width>" );
        writer.print( width );
        writer.println( "</width>" );

        writer.print( "      <height>" );
        writer.print( height );
        writer.println( "</height>" );

        if ( description != null )
        {
            writer.print( "      <description>" );
            writer.print( description );
            writer.println( "</description>" );
        }

        writer.println( "    </image>" );
    }

}