schemacrawler.crawl.MutableFunction 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.22.3

Show newest version

/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2024, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------

SchemaCrawler 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.

SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.

You may elect to redistribute this code under any of these licenses.

The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html

The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/

========================================================================
*/

package schemacrawler.crawl;

import static java.util.Objects.requireNonNull;

import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

import schemacrawler.schema.Function;
import schemacrawler.schema.FunctionParameter;
import schemacrawler.schema.FunctionReturnType;
import schemacrawler.schema.RoutineType;
import schemacrawler.schema.Schema;

/** Represents a database function. Created from metadata returned by a JDBC call. */
final class MutableFunction extends MutableRoutine implements Function {

  private static final long serialVersionUID = 3906925686089134130L;

  private final NamedObjectList columns = new NamedObjectList<>();
  private FunctionReturnType returnType;

  MutableFunction(final Schema schema, final String name, final String specificName) {
    super(schema, name, specificName);
    // Default values
    returnType = FunctionReturnType.unknown;
  }

  /** {@inheritDoc} */
  @Override
  public List getParameters() {
    return new ArrayList<>(columns.values());
  }

  /** {@inheritDoc} */
  @Override
  public FunctionReturnType getReturnType() {
    return returnType;
  }

  @Override
  public RoutineType getRoutineType() {
    return RoutineType.function;
  }

  /** {@inheritDoc} */
  @Override
  public Optional lookupParameter(final String name) {
    return columns.lookup(this, name);
  }

  void addParameter(final MutableFunctionParameter column) {
    columns.add(column);
  }

  void setReturnType(final FunctionReturnType returnType) {
    this.returnType = requireNonNull(returnType, "Null function return type");
  }
}