schemacrawler.schema.JdbcDriverProperty Maven / Gradle / Ivy

Go to download

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

SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.

There is a newer version: 16.24.2

Show newest version

/*
 *
 * SchemaCrawler
 * http://sourceforge.net/projects/schemacrawler
 * Copyright (c) 2000-2015, Sualeh Fatehi.
 *
 * 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 schemacrawler.schema;


import java.util.Collection;

/**
 * Represents a JDBC driver property, and it's value.
 *
 * @author sfatehi
 */
public interface JdbcDriverProperty
  extends Property
{

  /**
   * Gets the array of possible values if the value for the field
   * DriverPropertyInfo.value may be selected from a
   * particular set of values.
   *
   * @return Available choices for the value of a property
   */
  Collection getChoices();

  /**
   * Gets the the current value of the property, based on a combination
   * of the information supplied to the method
   * getPropertyInfo, the Java environment, and the
   * driver-supplied default values. This field may be null if no value
   * is known.
   *
   * @return Value of the property
   */
  @Override
  String getValue();

  /**
   * The required field is true if a value
   * must be supplied for this property during
   * Driver.connect and false otherwise.
   *
   * @return Whether the property is required
   */
  boolean isRequired();

}