Class List Method List File List

# Class: VertxSqlClient::RowSet

Inherits:
  SqlResult
  - Object
  - SqlResult
  - VertxSqlClient::RowSet
  show all
Defined in:
  /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb

## Overview

A set of rows.

## Constant Summary

@@j_api_type =

      Object.new

## Class Method Summary (collapse)

- + (Boolean) accept?(obj)
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)

## Instance Method Summary (collapse)

- - (Array<String>) columns_names
  Get the names of columns in the SqlResult.
- - (::VertxSqlClient::RowIterator) iterator
- - (::VertxSqlClient::RowSet) next
- - (Object) property(propertyKind = nil)
  Get the property with the specified PropertyKind.
- - (Fixnum) row_count
  Get the number of the affected rows in the operation to this SqlResult.
- - (Fixnum) size
  Get the number of rows retrieved in the SqlResult.
- - (::VertxSqlClient::RowSet) value
  Get the result value.

## Class Method Details

### + (`Boolean`) accept?(obj)

Returns:

- (`Boolean`)

    21
    22
    23
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 21

    def @@j_api_type.accept?(obj)
      obj.class == RowSet
    end

### + (`Object`) j_api_type

    30
    31
    32
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 30

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

    33
    34
    35
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 33

    def self.j_class
      Java::IoVertxSqlclient::RowSet.java_class
    end

### + (`Object`) unwrap(obj)

    27
    28
    29
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 27

    def @@j_api_type.unwrap(obj)
      obj.j_del
    end

### + (`Object`) wrap(obj)

    24
    25
    26
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 24

    def @@j_api_type.wrap(obj)
      RowSet.new(obj)
    end

## Instance Method Details

### - (`Array<String>`) columns_names

Get the names of columns in the SqlResult.

Returns:

- (`Array<String>`) —
  the list of names of columns.

Raises:

- (`ArgumentError`)

    46
    47
    48
    49
    50
    51
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 46

    def columns_names
      if !block_given?
        return @j_del.java_method(:columnsNames, []).call().to_a.map { |elt| elt }
      end
      raise ArgumentError, "Invalid arguments when calling columns_names()"
    end

### - (`::VertxSqlClient::RowIterator`) iterator

Returns:

- (`::VertxSqlClient::RowIterator`)

Raises:

- (`ArgumentError`)

    78
    79
    80
    81
    82
    83
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 78

    def iterator
      if !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:iterator, []).call(),::VertxSqlClient::RowIterator)
      end
      raise ArgumentError, "Invalid arguments when calling iterator()"
    end

### - (`::VertxSqlClient::RowSet`) next

Returns:

- (`::VertxSqlClient::RowSet`)

Raises:

- (`ArgumentError`)

    85
    86
    87
    88
    89
    90
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 85

    def next
      if !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:next, []).call(),::VertxSqlClient::RowSet)
      end
      raise ArgumentError, "Invalid arguments when calling next()"
    end

### - (`Object`) property(propertyKind = nil)

Get the property with the specified PropertyKind.

Parameters:

- propertyKind (`::VertxSqlClient::PropertyKind`) (defaults to: `nil`) —
  the kind of the property

Returns:

- (`Object`) —
  the value of the property

Raises:

- (`ArgumentError`)

    63
    64
    65
    66
    67
    68
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 63

    def property(propertyKind=nil)
      if propertyKind.class.method_defined?(:j_del) && !block_given?
        return ::Vertx::Util::Utils.from_object(@j_del.java_method(:property, [Java::IoVertxSqlclient::PropertyKind.java_class]).call(propertyKind.j_del))
      end
      raise ArgumentError, "Invalid arguments when calling property(#{propertyKind})"
    end

### - (`Fixnum`) row_count

Get the number of the affected rows in the operation to this SqlResult.

Returns:

- (`Fixnum`) —
  the count of affected rows.

Raises:

- (`ArgumentError`)

    38
    39
    40
    41
    42
    43
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 38

    def row_count
      if !block_given?
        return @j_del.java_method(:rowCount, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling row_count()"
    end

### - (`Fixnum`) size

Get the number of rows retrieved in the SqlResult.

Returns:

- (`Fixnum`) —
  the count of rows.

Raises:

- (`ArgumentError`)

    54
    55
    56
    57
    58
    59
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 54

    def size
      if !block_given?
        return @j_del.java_method(:size, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling size()"
    end

### - (`::VertxSqlClient::RowSet`) value

Get the result value.

Returns:

- (`::VertxSqlClient::RowSet`) —
  the result

Raises:

- (`ArgumentError`)

    71
    72
    73
    74
    75
    76
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-sql-client/row_set.rb', line 71

    def value
      if !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:value, []).call(),::VertxSqlClient::RowSet)
      end
      raise ArgumentError, "Invalid arguments when calling value()"
    end