Package io.github.mfvanek.pg.model.function

Class StoredFunction

java.lang.Object
io.github.mfvanek.pg.model.function.StoredFunction
All Implemented Interfaces:
DbObject, Comparable<StoredFunction>
@Immutable public class StoredFunction extends Object implements DbObject, Comparable<StoredFunction>
A representation of any stored procedure/function.
Since:
0.7.0

  • Method Details

    • getName

      @Nonnull public final String getName()
      Retrieves database object name.
      Specified by:
      getName in interface DbObject
      Returns:
      database object name

    • getObjectType

      @Nonnull public final PgObjectType getObjectType()
      Retrieves database object type.
      Specified by:
      getObjectType in interface DbObject
      Returns:
      database object type

    • getFunctionName

      @Nonnull public String getFunctionName()
      Retrieves procedure/function name.
      Returns:
      returns procedure/function name

    • getFunctionSignature

      @Nonnull public String getFunctionSignature()
      Retrieves procedure/function arguments.
      Returns:
      returns procedure/function arguments or empty string

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • equals

      public final boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • compareTo

      public int compareTo(@Nonnull StoredFunction other)
      Specified by:
      compareTo in interface Comparable<StoredFunction>

    • ofNoArgs

      public static StoredFunction ofNoArgs(@Nonnull String functionName)
      Constructs a StoredFunction object without arguments/signature.
      Parameters:
      functionName - procedure/function name.
      Returns:
      StoredFunction

    • of

      public static StoredFunction of(@Nonnull String functionName, @Nonnull String functionSignature)
      Constructs a StoredFunction object.
      Parameters:
      functionName - procedure/function name.
      functionSignature - procedure/function signature (arguments).
      Returns:
      StoredFunction