Constructor Detail

• ProfilePicture

  public ProfilePicture​(java.io.File file)
                 throws java.io.IOException

  Constructs the profile picture from a file, assuming it is the "DETAIL_UploadedProfileImage" file.

  Parameters:

  file - The profile picture.

  Throws:

  java.io.IOException - If the file data cannot be loaded, the size is too large, the file extension is not ".png", ".jpg" or ".jpeg".

• ProfilePicture

  public ProfilePicture​(java.io.File file,
                        java.lang.String type)
                 throws java.io.IOException

  Constructs the profile picture from a file, assuming it is the "DETAIL_UploadedProfileImage" file.

  Parameters:

  file - The profile picture.

  type - The image type for database details:
  IBasicUserInfoDetailNames.DETAIL_UploadedProfileImage,
  IBasicUserInfoDetailNames.DETAIL_LargeProfileImage; or
  IBasicUserInfoDetailNames.DETAIL_ThumbnailProfileImage.

  Throws:

  java.io.IOException - If the file data cannot be loaded, the size is too large (larger than 1 MB), the file extension is not ".png", ".jpg" or ".jpeg".

  java.lang.IllegalArgumentException - If type is not
  IBasicUserInfoDetailNames.DETAIL_UploadedProfileImage or null,
  IBasicUserInfoDetailNames.DETAIL_LargeProfileImage; or
  IBasicUserInfoDetailNames.DETAIL_ThumbnailProfileImage.

• ProfilePicture

  public ProfilePicture​(java.lang.String type,
                        java.lang.String name,
                        byte[] data)

  Constructor of the file when only data and type and filename is present.

  Parameters:

  type - The type.

  name - The file name of the profile picture.

  data - The byte data of the file.

  Throws:

  java.lang.IllegalArgumentException - If type is not
  IBasicUserInfoDetailNames.DETAIL_UploadedProfileImage or null,
  IBasicUserInfoDetailNames.DETAIL_LargeProfileImage; or
  IBasicUserInfoDetailNames.DETAIL_ThumbnailProfileImage.

Method Detail

• clone

  public ProfilePicture clone()

  Clones the instance.

  Overrides:

  clone in class java.lang.Object

  Returns:

  A cloned instance where temporary files are not cloned in, i.e. it's a fresh copy without temporary directory and/or file.

• getType

  public java.lang.String getType()

  Gets the profile image details type string.

  Returns:

  The detail:
  IBasicUserInfoDetailNames.DETAIL_UploadedProfileImage,
  IBasicUserInfoDetailNames.DETAIL_LargeProfileImage; or
  IBasicUserInfoDetailNames.DETAIL_ThumbnailProfileImage.

• getName

  public java.lang.String getName()

  Returns the (file) name of the profile picture.

  Returns:

  The (file) name, without path.

• getImageInputStream

  public java.io.ByteArrayInputStream getImageInputStream()

  Gets the image array as an input stream.

  Returns:

  Image input stream.

• getImageDataSize

  public int getImageDataSize()

  Gets the size of the image byte data.

  Returns:

  The byte count of the image data, i.e. the file size on disk in bytes.

• getImageExtension

  public java.lang.String getImageExtension()

  Gets the image extension without ".".

  Returns:

  The image extension, "png" or "jpg".

• deleteTemporaries

  public boolean deleteTemporaries()

  Cleans up any temporary files or directories created. If this method is called and there are temporary file(s), nothing will be performed.

  Errors during deleting of files is logged.

  Returns:

  true if temporary file(s) where deleted.

• getFile

  public java.io.File getFile​(java.io.File dir,
                              boolean isTemporary)
                       throws java.io.IOException

  Gets the file for the profile image.

  If this method is called with previous temporary files and/or directories, those are deleted prior to returning, depending on the isTemporary flag.

  Parameters:

  dir - Directory where to place the temporary file. If the dir parameter is null then a temporary directory will be created and the profile picture file placed inside. The creation of the temporary file and/or directory is only done once.

  isTemporary - If the file that is created should be considered as temporary or not. If not temporary, the created file (if created) will not be deleted.

  Returns:

  file The file, a potentially temporary file when created depending on the isTemporary parameter.

  Use the method deleteTemporaries() to clean-up.

  Throws:

  java.io.IOException - For I/O errors.

• getFile

  public java.io.File getFile()
                       throws java.io.IOException

  Gets the file for the profile image.

  If this method is called with previous temporary files and/or directories, those are deleted prior to returning.

  Returns:

  file A temporary file created.

  Use the method deleteTemporaries() to clean-up.

  Throws:

  java.io.IOException - For I/O errors.

• toString

  public java.lang.String toString()

  A string representation.

  Overrides:

  toString in class java.lang.Object

  Returns:

  String as "className[fileName,type]".

• equals

  public boolean equals​(java.lang.Object o)

  Checks if equal with another.

  Overrides:

  equals in class java.lang.Object

  Returns:

  true if name, type matched and contents are the same, false otherwise.

• hashCode

  public int hashCode()

  Hash code of the instance.

  Overrides:

  hashCode in class java.lang.Object

  Returns:

  Hash code of name, type and data.

• finalize

  protected void finalize()
                   throws java.lang.Throwable

  Finalized: delete temporaries.

  Overrides:

  finalize in class java.lang.Object

  Throws:

  java.lang.Throwable