com.screenscraper.http.models

Class RequestParameter

java.lang.Object

com.screenscraper.http.models.RequestParameter

public class RequestParameter
extends java.lang.Object

Represents a request parameter (key and value). Either file or value will be not null, and the other will always be null

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
RequestParameter(java.lang.String key, java.io.File file) Builds the parameter
RequestParameter(java.lang.String key, java.lang.String value) Builds the parameter

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() Returns the File for the object
java.lang.String	getKey() Returns the Key for the object
java.lang.String	getValue() Returns the Value for the object
boolean	isFileType() Returns true iff this is a file upload type (this also means getFile is not null)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestParameter

public RequestParameter(@NotNull
                        java.lang.String key,
                        @NotNull
                        java.lang.String value)

Builds the parameter

Parameters:

key - The key

value - The value

RequestParameter

public RequestParameter(@NotNull
                        java.lang.String key,
                        @NotNull
                        java.io.File file)

Builds the parameter

Parameters:

key - The key

file - The file

Method Detail

getKey

@NotNull
public java.lang.String getKey()

Returns the Key for the object

Returns:

The Key for the object

getValue

@Nullable
public java.lang.String getValue()

Returns the Value for the object

Returns:

The Value for the object

getFile

@Nullable
public java.io.File getFile()

Returns the File for the object

Returns:

The File for the object

isFileType

public boolean isFileType()

Returns true iff this is a file upload type (this also means getFile is not null)

Returns:

True iff this is a file upload type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object