/*
 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.
 =================== DO NOT EDIT THIS FILE ====================
 Generated by Modello 2.5.1,
 any modifications will be overwritten.
 ==============================================================
 */

package org.apache.maven.doxia.module.fml.model;

/**
 * 
 *          The <code>&lt;faqs&gt;</code> element is the root of
 * the FML descriptor.
 *          The following table lists all of the possible child
 * elements.
 *       
 * 
 * @version $Revision$ $Date$
 */
@SuppressWarnings( "all" )
public class Faqs
    implements java.io.Serializable
{

      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * 
     *             The title name of this FAQ.
     *           
     */
    private String title = "FAQ";

    /**
     * 
     *             Boolean to generate optionally [top] links.
     *           
     */
    private boolean toplink = true;

    /**
     * Field parts.
     */
    private java.util.List<Part> parts;

    /**
     * Field modelEncoding.
     */
    private String modelEncoding = "UTF-8";


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Method addPart.
     * 
     * @param part a part object.
     */
    public void addPart( Part part )
    {
        getParts().add( part );
    } //-- void addPart( Part )

    /**
     * Method equals.
     * 
     * @param other a other object.
     * @return boolean
     */
    public boolean equals( Object other )
    {
        if ( this == other )
        {
            return true;
        }

        if ( !( other instanceof Faqs ) )
        {
            return false;
        }

        Faqs that = (Faqs) other;
        boolean result = true;

        result = result && ( getTitle() == null ? that.getTitle() == null : getTitle().equals( that.getTitle() ) );
        result = result && toplink == that.toplink;
        result = result && ( getParts() == null ? that.getParts() == null : getParts().equals( that.getParts() ) );

        return result;
    } //-- boolean equals( Object )

    /**
     * Get the modelEncoding field.
     * 
     * @return String
     */
    public String getModelEncoding()
    {
        return this.modelEncoding;
    } //-- String getModelEncoding()

    /**
     * Method getParts.
     * 
     * @return List
     */
    public java.util.List<Part> getParts()
    {
        if ( this.parts == null )
        {
            this.parts = new java.util.ArrayList<Part>();
        }

        return this.parts;
    } //-- java.util.List<Part> getParts()

    /**
     * Get the title name of this FAQ.
     * 
     * @return String
     */
    public String getTitle()
    {
        return this.title;
    } //-- String getTitle()

    /**
     * Method hashCode.
     * 
     * @return int
     */
    public int hashCode()
    {
        int result = 17;

        result = 37 * result + ( title != null ? title.hashCode() : 0 );
        result = 37 * result + ( toplink ? 0 : 1 );
        result = 37 * result + ( parts != null ? parts.hashCode() : 0 );

        return result;
    } //-- int hashCode()

    /**
     * Get boolean to generate optionally [top] links.
     * 
     * @return boolean
     */
    public boolean isToplink()
    {
        return this.toplink;
    } //-- boolean isToplink()

    /**
     * Method removePart.
     * 
     * @param part a part object.
     */
    public void removePart( Part part )
    {
        getParts().remove( part );
    } //-- void removePart( Part )

    /**
     * Set the modelEncoding field.
     * 
     * @param modelEncoding a modelEncoding object.
     */
    public void setModelEncoding( String modelEncoding )
    {
        this.modelEncoding = modelEncoding;
    } //-- void setModelEncoding( String )

    /**
     * Set list of FAQ part.
     * 
     * @param parts a parts object.
     */
    public void setParts( java.util.List<Part> parts )
    {
        this.parts = parts;
    } //-- void setParts( java.util.List )

    /**
     * Set the title name of this FAQ.
     * 
     * @param title a title object.
     */
    public void setTitle( String title )
    {
        this.title = title;
    } //-- void setTitle( String )

    /**
     * Set boolean to generate optionally [top] links.
     * 
     * @param toplink a toplink object.
     */
    public void setToplink( boolean toplink )
    {
        this.toplink = toplink;
    } //-- void setToplink( boolean )

    /**
     * Method toString.
     * 
     * @return String
     */
    public java.lang.String toString()
    {
        StringBuilder buf = new StringBuilder( 128 );

        buf.append( "title = '" );
        buf.append( getTitle() );
        buf.append( "'" );
        buf.append( "\n" ); 
        buf.append( "toplink = '" );
        buf.append( isToplink() );
        buf.append( "'" );
        buf.append( "\n" ); 
        buf.append( "parts = '" );
        buf.append( getParts() );
        buf.append( "'" );

        return buf.toString();
    } //-- java.lang.String toString()

}