Class ProfilePicture

Method Details

• clone

  public ProfilePicture clone()

  Clones the instance.

  Overrides:

  clone in class 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 String getType()

  Gets the profile image details type string.

  Returns:

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

• getName

  public String getName()

  Returns the (file) name of the profile picture.

  Returns:

  The (file) name, without path.

• getImageInputStream

  public 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 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 File getFile(File dir, boolean isTemporary) throws 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:

  IOException - For I/O errors.

• getFile

  public File getFile() throws 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:

  IOException - For I/O errors.

• toString

  public String toString()

  A string representation.

  Overrides:

  toString in class Object

  Returns:

  String as "className[fileName,type]".

• equals

  public boolean equals(Object o)

  Checks if equal with another.

  Overrides:

  equals in class 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 Object

  Returns:

  Hash code of name, type and data.

• finalize

  protected void finalize() throws Throwable

  Finalized: delete temporaries.

  Overrides:

  finalize in class Object

  Throws:

  Throwable