Index
All Classes and Interfaces|All Packages
A
- addCredentials(String, String, String) - Method in class io.github.mastodonContentMover.ClientCredentialStore
-
Adds a
client-key
andclient-secret
pair that grant application-level API read and write access for the tool on a Mastodon instance, specified by hostname or address, to the data store within thisClientCredentialStore
object and saves its state to file in an XML format using JAXB. - addCredentials(String, String, String) - Method in class io.github.mastodonContentMover.UserCredentialStore
-
Adds a user-level API access token for a specified user account on a Mastodon instance specified by hostname or address to the object data store within this
UserCredentialStore
object and saves its state to file in an XML format using JAXB. - addMastodonId(String) - Method in class io.github.mastodonContentMover.Post
- addMedia(String, String, String, String, float, float) - Method in class io.github.mastodonContentMover.Post
- addPost(String, String) - Method in class io.github.mastodonContentMover.PostArchive
-
Creates a new
Post
object in this archive for a status with the specified creation date and time, and the specifiedmastodonId
. - Authenticator - Class in io.github.mastodonContentMover
-
Handles the process of authenticating a connection with a Mastodon instance, using an OAuth callback facilitated by
OAuthListener
— a minimal HTTP server that runs briefly on the local machine to receive a call from the browser on that machine to thelocalhost
.
C
- checkDataDirectoryExists() - Static method in class io.github.mastodonContentMover.Mover
-
Confirms whether the application's data directory exists at the location specified by the
DATA_DIRECTORY
constant, and tries to create it if it does not. - ClientCredentialSet - Class in io.github.mastodonContentMover
-
Holds in an XML-persistable object a
client-key
andclient-secret
pair that grants application-level API credentials for the tool with a Mastodon instance. - ClientCredentialSet(String, String) - Constructor for class io.github.mastodonContentMover.ClientCredentialSet
- ClientCredentialStore - Class in io.github.mastodonContentMover
-
Holds in an XML-persistable object the application-level API credentials for the tool with respective Mastodon instances, using
ClientCredentialSet
objects to store individualclient-key
andclient-secret
pairs.
G
- getAccessToken(String, String) - Method in class io.github.mastodonContentMover.UserCredentialStore
-
Retrieves a user-level API access token for a specified user account on a Mastodon instance specified by hostname or address from the object data store within this
UserCredentialStore
instance. - getAllPosts() - Method in class io.github.mastodonContentMover.PostArchive
-
Obtains a
Collection
view of allPost
objects held in this archive, from oldest to newest when iterated. - getAltText() - Method in class io.github.mastodonContentMover.MediaFile
-
Retrieves the alt text or description of the content in the media file associated with this
MediaFile
, corresponding to thedescription
field within Mastodon. - getArchiveId() - Method in class io.github.mastodonContentMover.Post
- getClient(String, String, Integer) - Method in class io.github.mastodonContentMover.Authenticator
-
Obtains an authenticated
MastodonClient
object for the specified user account on the specified Mastodon instance, using saved credentials from previous use of the tool or by exhausting the various possible methods of authentication in order of preference. - getClientKey() - Method in class io.github.mastodonContentMover.ClientCredentialSet
-
Retrieves the
client-key
that, together with aclient-secret
, grants application-level API access token for this tool on a Mastodon instance. - getClientSecret() - Method in class io.github.mastodonContentMover.ClientCredentialSet
-
Retrieves the
client-secret
that, together with aclient-key
, grants application-level API access token for this tool on a Mastodon instance. - getCredentials(String) - Method in class io.github.mastodonContentMover.ClientCredentialStore
-
Retrieves a
client-key
andclient-secret
pair that grant application-level API read and write access for the tool on a Mastodon instance, specified by hostname or address, contained within aClientCredentialSet
object, from the data store within thisClientCredentialStore
object. - getDataDirectory() - Static method in class io.github.mastodonContentMover.Mover
-
Provides the location of the application's data directory, currently as specified by the
DATA_DIRECTORY
constant. - getDebugPrefix() - Static method in class io.github.mastodonContentMover.Mover
-
Provides the prefix used when debug messages are printed to the console, as specified by the
DEBUG_PREFIX
constant. - getDirectory() - Method in class io.github.mastodonContentMover.PostArchive
-
Obtain the filesystem directory name within which data for this
PostArchive
instance is stored. - getErrorMessagePrefix() - Static method in class io.github.mastodonContentMover.Mover
-
Provides the prefix used when error messages are printed to the console, as specified by the
ERROR_MESSAGE_PREFIX
constant. - getFavouritesCount() - Method in class io.github.mastodonContentMover.Post
-
Obtains as a primitive
long
the number of a count of favourites for the status represented by thisPost
object. - getFilepath() - Method in class io.github.mastodonContentMover.MediaFile
-
Retrieves the path on the local file system for the media file associated with this
MediaFile
object. - getFocalPointX() - Method in class io.github.mastodonContentMover.MediaFile
-
Retrieves x coordinate of the focal point for the media file associated with this
MediaFile
object. - getFocalPointY() - Method in class io.github.mastodonContentMover.MediaFile
-
Retrieves y coordinate of the focal point for the media file associated with this
MediaFile
object. - getInReplyToArchiveId() - Method in class io.github.mastodonContentMover.Post
- getInstance(int) - Static method in class io.github.mastodonContentMover.OAuthListener
-
Obtains a reference to the currently instantiated
OAuthListener
singleton object, or instantiates one if that has not already been done using the port specified. - getInstanceAddressFromMastodonId(String) - Static method in class io.github.mastodonContentMover.PostArchive
-
Retrieves the Mastodon instance hostname or address from a concatenated
mastodonId
String
value that also contains a separator and the id used for a status on that instance. - getInstanceIdFromMastodonId(String) - Static method in class io.github.mastodonContentMover.PostArchive
-
Retrieves the id used for a status on a Mastodon instance from a concatenated
mastodonId
String
value that also contains the Mastodon instance hostname or address. - getLanguage() - Method in class io.github.mastodonContentMover.Post
- getLatestMastodonId(String) - Method in class io.github.mastodonContentMover.Post
-
Returns the most recent Mastodon instance id used for this
Post
on the instance specified as a parameter. - getMastodonId(String, String) - Static method in class io.github.mastodonContentMover.PostArchive
- getMastodonIds() - Method in class io.github.mastodonContentMover.Post
- getMastodonMediaType() - Method in class io.github.mastodonContentMover.MediaFile
-
Retrieves the Mastodon media type for the media file associated with this
MediaFile
, corresponding to thedescription
field within Mastodon. - getMedia() - Method in class io.github.mastodonContentMover.Post
- getMimeType() - Method in class io.github.mastodonContentMover.MediaFile
-
Retrieves the MIME type of the media file associated with this
MediaFile
object, used when reuploading the file to Mastodon to attach to a reposted status. - getPostByArchiveId(String) - Method in class io.github.mastodonContentMover.PostArchive
-
Retrieves a reference to the
Post
object with the specifiedarchiveId
, based on the creation date and time of a Mastodon status, stored in thisPostArchive
- getPostByMastodonId(String) - Method in class io.github.mastodonContentMover.PostArchive
-
Retrieves a reference to the
Post
object in thisPostArchive
with the specifiedmastodonId
, which is comprised of the address or hostname of the instance from which thePost
was saved or has been reposted, and the internal id of the corresponding status on that instance. - getPostCount() - Method in class io.github.mastodonContentMover.PostArchive
-
Obtain the number of
Post
objects currently stored within thisPostArchive
instance. - getReblogsCount() - Method in class io.github.mastodonContentMover.Post
-
Obtains as a primitive
long
the number of times the Mastodon status represented by thisPost
object was reblogged. - getReblogUrl() - Method in class io.github.mastodonContentMover.Post
- getSingletonInstance() - Static method in class io.github.mastodonContentMover.Authenticator
-
Obtains a reference to the currently instantiated
Authenticator
singleton object, or instantiates one if that has not already been done. - getSingletonInstance() - Static method in class io.github.mastodonContentMover.ClientCredentialStore
-
Obtains a reference to the currently instantiated
ClientCredentialStore
singleton object, or instantiates one if that has not already been done. - getSingletonInstance() - Static method in class io.github.mastodonContentMover.UserCredentialStore
-
Obtains a reference to the currently instantiated
UserCredentialStore
singleton object, or instantiates one if that has not already been done. - getSingletonInstance(String, boolean) - Static method in class io.github.mastodonContentMover.PostArchive
-
Obtains a reference to the currently instantiated
PostArchive
singleton object, if the specified archive name is the same, or instantiates one if that has not already been done. - getSpoilerText() - Method in class io.github.mastodonContentMover.Post
-
Retrieves the value of the Mastodon
spoiler_text
field stored for thisPost
object. - getText() - Method in class io.github.mastodonContentMover.Post
-
Retrieves the plain text that comprises the body of the Mastodon status this
Post
object represents. - getThumbnailFilepath() - Method in class io.github.mastodonContentMover.MediaFile
-
Retrieves the path on the local file system for the thumbnail for the media file associated with this
MediaFile
object. - getThumbnailFileSuffix() - Static method in class io.github.mastodonContentMover.MediaFile
-
Obtain the suffix that should be attached to the name of a media file (without the file extension) when naming a thumbnail for that media file.
- getVisibility() - Method in class io.github.mastodonContentMover.Post
H
- hasMastodonId(String) - Method in class io.github.mastodonContentMover.Post
- hasMedia() - Method in class io.github.mastodonContentMover.Post
-
Indicates whether this
Post
object has any media attachments.
I
- io.github.mastodonContentMover - package io.github.mastodonContentMover
-
Saves statuses from a user account on a Mastodon instance to an XML-based archive on the local filesystem, and posts them as new statuses from that archive to a user account on a Mastodon instance, to preserve and migrate content in posted statuses when users migrate between Mastodon instances.
- isAfter(String) - Method in class io.github.mastodonContentMover.Post
- isBefore(String) - Method in class io.github.mastodonContentMover.Post
- isBookmarked() - Method in class io.github.mastodonContentMover.Post
-
Obtains a primitive
boolean
value that indicates whether the Mastodon status represented by thisPost
object is bookmarked by the account used to save it to the archive. - isFavourited() - Method in class io.github.mastodonContentMover.Post
-
Obtains a primitive
boolean
value that indicates whether the Mastodon status represented by thisPost
object is favourited by the account used to save it to the archive. - isPinned() - Method in class io.github.mastodonContentMover.Post
-
Obtains a primitive
boolean
value that indicates whether the Mastodon status represented by thisPost
object is pinned by the account used to save it to the archive. - isSensitive() - Method in class io.github.mastodonContentMover.Post
-
Obtains as a primitive
boolean
value the sensitivity of the Mastodon status represented by thisPost
object.
M
- main(String[]) - Static method in class io.github.mastodonContentMover.Mover
-
Initializes application, accepting command-line parameters, calling
parseParameters
to parse them into global variables and then calling the requested procedure accordingly. - MediaFile - Class in io.github.mastodonContentMover
-
Holds in an XML-persistable object the metadata associated with a media file attached to a
Post
object. - MediaFile(String) - Constructor for class io.github.mastodonContentMover.MediaFile
-
Creates a
MediaFile
object with the filename specified. - MediaFile(String, String, String, String, String, float, float) - Constructor for class io.github.mastodonContentMover.MediaFile
-
Creates a
MediaFile
object with the filename, directory, Mastodon media type, thumbnail filename, alt text (description) and focal point coordinates (x and y) specified. - Mover - Class in io.github.mastodonContentMover
-
Bootstraps application, parses command-line parameters, determines which function was requested by the user, and then performs that function.
- Mover() - Constructor for class io.github.mastodonContentMover.Mover
O
- oAuthCallback(String) - Method in class io.github.mastodonContentMover.Authenticator
-
Passes an OAuth callback code received by an instance of
OAuthListener
(which runs a separate thread) to this object, so it can then be collected byAuthenticator.getClient(String instance, String username, Integer customPort)
to perform further authentication tasks. - OAuthListener - Class in io.github.mastodonContentMover
-
Operates a minimal HTTP server on the local machine for the duration of OAuth authorization of the tool by a Mastodon instance, passing the callback code collected via an OAuth callback (from a browser on that machine) to the instantiated
Authenticator
singletone object.
P
- pausePersistence() - Method in class io.github.mastodonContentMover.Post
-
Halts the saving to file of changes to this
Post
object as and when they are made, until this behaviour is restored with . - Post - Class in io.github.mastodonContentMover
-
Holds in an XML-persistable object all the data associated with a Mastodon status, using
MediaFile
objects to store metadata associated with media files. - Post(String, String, PostArchive) - Constructor for class io.github.mastodonContentMover.Post
-
Loads the
Post
object with the specified archiveId in the specifiedPostArchive
from file if it is available, or creates a newPost
object if no data is found for that archiveId on the filesystem within the given data directory for the specifiedPostArchive
. - PostArchive - Class in io.github.mastodonContentMover
- postIsAfterDateTime(String, String) - Method in class io.github.mastodonContentMover.PostArchive
-
Determines whether a given
archiveId
is based on a date and time after a specified ISO 8601 compliantString
. - postIsBeforeDateTime(String, String) - Method in class io.github.mastodonContentMover.PostArchive
-
Determines whether a given
archiveId
is based on a date and time before a specified ISO 8601 compliantString
.
R
- registerPostByArchiveId(Post) - Method in class io.github.mastodonContentMover.PostArchive
-
Adds a reference to a
Post
object to the index maintained by this archive according to MastodonContentMover internalarchiveId
. - registerPostByMastodonId(Post, String) - Method in class io.github.mastodonContentMover.PostArchive
- resumePersistence() - Method in class io.github.mastodonContentMover.Post
-
Resumes the saving to file of changes to this
Post
object as and when they are made, and saves its current state to file.
S
- setAltText(String) - Method in class io.github.mastodonContentMover.MediaFile
-
Stores the value of the Mastodon
description
field, which is an alt text or description, for the media file associated with thisMediaFile
object. - setDirectory(String) - Method in class io.github.mastodonContentMover.MediaFile
-
Stores the directory where the media file associated with this
MediaFile
object is stored on the local file system. - setFavouritesCount(long) - Method in class io.github.mastodonContentMover.Post
-
Stores as a primitive
long
the number of favourites for the Mastodon status represented by thisPost
object, and saves the change to file if persistance has not been paused. - setFocalPoint(float, float) - Method in class io.github.mastodonContentMover.MediaFile
-
Stores the x and y coordinates of the focal point for the media file associated with this
MediaFile
object, which allow Mastodon to preview a limited area of an image according to the user's preferences when not all of it is visible in the user interface. - setInReplyToArchiveId(String) - Method in class io.github.mastodonContentMover.Post
- setIsBookmarked(boolean) - Method in class io.github.mastodonContentMover.Post
-
Stores as a primitive
boolean
whether the Mastodon status represented by thisPost
object is bookmarked by the account used to save it to the archive, and saves the change to file if persistance has not been paused. - setIsFavourited(boolean) - Method in class io.github.mastodonContentMover.Post
-
Stores as a primitive
boolean
whether the Mastodon status represented by thisPost
object is favourited by the account used to save it to the archive, and saves the change to file if persistance has not been paused. - setIsPinned(boolean) - Method in class io.github.mastodonContentMover.Post
-
Stores as a primitive
boolean
whether the Mastodon status represented by thisPost
object is pinned by the account used to save it to the archive, and saves the change to file if persistance has not been paused. - setIsSensitive(boolean) - Method in class io.github.mastodonContentMover.Post
-
Stores as a primitive
boolean
value the sensitivity of the Mastodon status represented by thisPost
object, and saves the change to file if persistance has not been paused. - setLanguage(String) - Method in class io.github.mastodonContentMover.Post
- setReblogsCount(long) - Method in class io.github.mastodonContentMover.Post
-
Stores as a primitive
long
the number of times the Mastodon status represented by thisPost
object was reblogged, and saves the change to file if persistance has not been paused. - setReblogUrl(String) - Method in class io.github.mastodonContentMover.Post
- setSpoilerText(String) - Method in class io.github.mastodonContentMover.Post
-
Stores the value of the Mastodon
spoiler_text
field in thisPost
object, and saves the change to file if persistance has not been paused. - setText(String) - Method in class io.github.mastodonContentMover.Post
-
Stores the Mastodon StatusSource, which is the plain text used to compose the status, to this
Post
object, and saves the change to file if persistance has not been paused. - setVisibility(String) - Method in class io.github.mastodonContentMover.Post
- showDebug() - Static method in class io.github.mastodonContentMover.Mover
-
Indicates whether debug messages should be printed to the console, according to whether that option was specified as a parameter when the application was run.
- shutdown() - Method in class io.github.mastodonContentMover.OAuthListener
-
Halts the HTTP server, allowing some time for the shutdown process to complete and then releasing resources that had been allocated to it.
U
- UserCredentialStore - Class in io.github.mastodonContentMover
-
Holds in an XML-persistable object the user-level API access tokens for user accounts on respective Mastodon instances.
All Classes and Interfaces|All Packages