Class HTTPFileArgs

    • Constructor Detail

      • HTTPFileArgs

        public HTTPFileArgs()
        Create a new HTTPFileArgs object with no files.
    • Method Detail

      • getHTTPFileArgsCollection

        public CollectionProperty getHTTPFileArgsCollection()
        Get the files.
        Returns:
        the files
      • setHTTPFileArgs

        public void setHTTPFileArgs​(List<HTTPFileArg> files)
        Set the list of files. Any existing files will be lost.
        Parameters:
        files - the new files
      • addHTTPFileArg

        public void addHTTPFileArg​(String path)
        Add a new file with the given path.
        Parameters:
        path - the path of the file
      • addHTTPFileArg

        public void addHTTPFileArg​(HTTPFileArg file)
        Add a new file.
        Parameters:
        file - the new file
      • addHTTPFileArg

        public void addHTTPFileArg​(String path,
                                   String param,
                                   String mime)
        adds a new File to the HTTPFileArgs list to be uploaded with http request.
        Parameters:
        path - file full path.
        param - http parameter name.
        mime - mime type of file.
      • iterator

        public PropertyIterator iterator()
        Get a PropertyIterator of the files.
        Returns:
        an iteration of the files
      • asArray

        public HTTPFileArg[] asArray()
        Get the current arguments as an array.
        Returns:
        an array of file arguments
      • toString

        public String toString()
        Create a string representation of the files.
        Overrides:
        toString in class Object
        Returns:
        the string representation of the files
      • removeHTTPFileArg

        public void removeHTTPFileArg​(int row)
        Remove the specified file from the list.
        Parameters:
        row - the index of the file to remove
      • removeHTTPFileArg

        public void removeHTTPFileArg​(HTTPFileArg file)
        Remove the specified file from the list.
        Parameters:
        file - the file to remove
      • removeHTTPFileArg

        public void removeHTTPFileArg​(String filePath)
        Remove the file with the specified path.
        Parameters:
        filePath - the path of the file to remove
      • removeAllHTTPFileArgs

        public void removeAllHTTPFileArgs()
        Remove all files from the list.
      • addEmptyHTTPFileArg

        public void addEmptyHTTPFileArg()
        Add a new empty file to the list. The new file will have the empty string as its path.
      • getHTTPFileArgCount

        public int getHTTPFileArgCount()
        Get the number of files in the list.
        Returns:
        the number of files
      • getHTTPFileArg

        public HTTPFileArg getHTTPFileArg​(int row)
        Get a single file.
        Parameters:
        row - the index of the file to return.
        Returns:
        the file at the specified index, or null if no file exists at that index.