@PublicApi public interface

SessionTempFile

com.atlassian.jira.io.SessionTempFile

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Wrapper for a temporary file that is bound to the HTTP session.

Summary

Public Methods
boolean delete()
Deletes the underlying File and unbinds this SessionTempFile from the current session.
@Nonnull File getFile()
Returns the underlying File object.
void unbind()
Unbinds this SessionTempFile from the current session.

Public Methods

public boolean delete ()

Deletes the underlying File and unbinds this SessionTempFile from the current session.

Returns
  • true if the underlying file has been deleted

@Nonnull public File getFile ()

Returns the underlying File object.

Returns
  • a File

public void unbind ()

Unbinds this SessionTempFile from the current session. The underlying file will no longer be deleted when the session is destroyed.

Note that this does not delete the underlying File