net.sf.mpxj.GenericCriteriaPrompt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

There is a newer version: 13.8.0

Show newest version

/*
 * file:       GenericCriteriaPrompt.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2010
 * date:       26/04/2010
 */

/*
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

package net.sf.mpxj;

/**
 * Represents a prompt to the user as part of filter criteria.
 */
public final class GenericCriteriaPrompt
{
   /**
    * Constructor.
    *
    * @param type prompt data type
    * @param prompt text
    */
   public GenericCriteriaPrompt(DataType type, String prompt)
   {
      m_type = type;
      m_prompt = prompt;
   }

   /**
    * Retrieve the data type of the expected value.
    *
    * @return data type
    */
   public DataType getType()
   {
      return m_type;
   }

   /**
    * Retrieves the prompt text.
    *
    * @return prompt text
    */
   public String getPrompt()
   {
      return m_prompt;
   }

   /**
    * {@inheritDoc}
    */
   @Override public String toString()
   {
      StringBuilder sb = new StringBuilder();
      sb.append("PROMPT(");
      sb.append(m_prompt);
      sb.append(")");
      return sb.toString();
   }

   private DataType m_type;
   private String m_prompt;
}