Class List Method List File List

# Class: VertxWeb::FileUpload

Inherits:
  Object
  - Object
  - VertxWeb::FileUpload
  show all
Defined in:
  /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb

## Overview

Represents a file-upload from an HTTP multipart form submission.

## 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)

- - (String) char_set
  The charset of the upload.
- - (String) content_transfer_encoding
  The content transfer encoding of the upload - this describes how the upload was encoded in the form submission.
- - (String) content_type
  The content type (MIME type) of the upload.
- - (String) file_name
  The file name of the upload as provided in the form submission.
- - (String) name
  The name of the upload as provided in the form submission.
- - (Fixnum) size
  The size of the upload, in bytes.
- - (String) uploaded_file_name
  The actual temporary file name on the server where the file was uploaded to.

## Class Method Details

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

Returns:

- (`Boolean`)

    18
    19
    20
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 18

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

### + (`Object`) j_api_type

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

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

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

    def self.j_class
      Java::IoVertxExtWeb::FileUpload.java_class
    end

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

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

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

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

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

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

## Instance Method Details

### - (`String`) char_set

Returns the charset of the upload

Returns:

- (`String`) —
  the charset of the upload

Raises:

- (`ArgumentError`)

    76
    77
    78
    79
    80
    81
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 76

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

### - (`String`) content_transfer_encoding

Returns the content transfer encoding of the upload - this describes how the upload was encoded in the form submission.

Returns:

- (`String`) —
  the content transfer encoding of the upload - this describes how the upload was encoded in the form submission.

Raises:

- (`ArgumentError`)

    69
    70
    71
    72
    73
    74
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 69

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

### - (`String`) content_type

Returns the content type (MIME type) of the upload

Returns:

- (`String`) —
  the content type (MIME type) of the upload

Raises:

- (`ArgumentError`)

    62
    63
    64
    65
    66
    67
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 62

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

### - (`String`) file_name

Returns the file name of the upload as provided in the form submission

Returns:

- (`String`) —
  the file name of the upload as provided in the form submission

Raises:

- (`ArgumentError`)

    48
    49
    50
    51
    52
    53
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 48

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

### - (`String`) name

Returns the name of the upload as provided in the form submission

Returns:

- (`String`) —
  the name of the upload as provided in the form submission

Raises:

- (`ArgumentError`)

    34
    35
    36
    37
    38
    39
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 34

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

### - (`Fixnum`) size

Returns the size of the upload, in bytes

Returns:

- (`Fixnum`) —
  the size of the upload, in bytes

Raises:

- (`ArgumentError`)

    55
    56
    57
    58
    59
    60
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 55

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

### - (`String`) uploaded_file_name

Returns the actual temporary file name on the server where the file was uploaded to.

Returns:

- (`String`) —
  the actual temporary file name on the server where the file was uploaded to.

Raises:

- (`ArgumentError`)

    41
    42
    43
    44
    45
    46
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/file_upload.rb', line 41

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