io.vertx.sqlclient.desc.ColumnDescriptor Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017 Julien Viet
 *
 * Licensed 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.
 *
 */
package io.vertx.sqlclient.desc;

import io.vertx.codegen.annotations.VertxGen;

import java.sql.JDBCType;

@VertxGen
public interface ColumnDescriptor {

  /**
   * @return the column name
   */
  String name();

  /**
   * @return whether the column is an array
   */
  boolean isArray();

  /**
   * @return vendor-specific name of the column type, or {@code null} if unknown
   */
  String typeName();

  /**
   * @return the most appropriate {@code JDBCType}
   */
  JDBCType jdbcType();

}