From f012977aaca0209c635560d6a77156c24c083943 Mon Sep 17 00:00:00 2001 From: JaniruTEC <52893617+JaniruTEC@users.noreply.github.com> Date: Fri, 11 Sep 2020 21:47:30 +0200 Subject: [PATCH] Fixed spelling See: https://github.com/cryptomator/cryptomator/pull/1307#discussion_r472825411 --- .../common/mountpoint/MountPointChooser.java | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/main/commons/src/main/java/org/cryptomator/common/mountpoint/MountPointChooser.java b/main/commons/src/main/java/org/cryptomator/common/mountpoint/MountPointChooser.java index 0da0f6b3d..f4b35b7bb 100644 --- a/main/commons/src/main/java/org/cryptomator/common/mountpoint/MountPointChooser.java +++ b/main/commons/src/main/java/org/cryptomator/common/mountpoint/MountPointChooser.java @@ -8,7 +8,7 @@ import java.util.SortedSet; /** * Base interface for the Mountpoint-Choosing-Operation that results in the choice and - * preparation of a Mountpoint or an exception otherwise.
+ * preparation of a mountpoint or an exception otherwise.
*

All MountPointChoosers (MPCs) need to implement this class and must be added to * the pool of possible MPCs by the {@link MountPointChooserModule MountPointChooserModule.} * The MountPointChooserModule will sort them according to their {@link #getPriority() priority.} @@ -16,24 +16,24 @@ import java.util.SortedSet; * the order of execution of MPCs with equal priority is undefined. * *

MPCs are executed by a {@link Volume} in ascedning order of their priority to find - * and prepare a suitable Mountpoint for the Volume. The Volume has access to a + * and prepare a suitable mountpoint for the volume. The volume has access to a * {@link SortedSet} of MPCs in this specific order, that is provided by the Module. * The Set only contains Choosers that were deemed {@link #isApplicable() applicable} * by the Module. * - *

At execution of a MPC {@link #chooseMountPoint()} is called to choose a Mountpoint + *

At execution of a MPC {@link #chooseMountPoint()} is called to choose a mountpoint * according to the MPC's strategy. The strategy can involve reading configs, * searching the filesystem, processing user-input or similar operations. * If {@code #chooseMountPoint()} returns a non-null path (everthing but * {@linkplain Optional#empty()}) the MPC's {@link #prepare(Path)}-Method is called and the * MountPoint is verfied and/or prepared. In this case no other MPC's will be called for - * this Volume, even if {@code #prepare(Path)} fails. + * this volume, even if {@code #prepare(Path)} fails. * *

If {@code #chooseMountPoint()} yields no result, the next MPC is executed * without first calling the {@code #prepare(Path)}-Method of the current MPC. * This is repeated until
*

@@ -57,42 +57,42 @@ public interface MountPointChooser extends Comparable { boolean isApplicable(); /** - * Called by a {@link Volume} to choose a Mountpoint according to the + * Called by a {@link Volume} to choose a mountpoint according to the * MountPointChoosers strategy. * *

This method is only called for MPCs that were deemed {@link #isApplicable() applicable} * by the {@link MountPointChooserModule MountPointChooserModule.} - * Developers should override this method to find or extract a Mountpoint for - * the Volume without preparing it. Preparation should be done by + * Developers should override this method to find or extract a mountpoint for + * the volume without preparing it. Preparation should be done by * {@link #prepare(Path)} instead. * Exceptions in this method should be handled gracefully and result in returning * {@link Optional#empty()} instead of throwing an exception. * * @return the chosen path or {@link Optional#empty()} if an exception occurred - * or no Mountpoint could be found. + * or no mountpoint could be found. * @see #isApplicable() * @see #prepare(Path) */ Optional chooseMountPoint(); /** - * Called by a {@link Volume} to prepare and/or verify the chosen Mountpoint.
+ * Called by a {@link Volume} to prepare and/or verify the chosen mountpoint.
* This method is only called if the {@link #chooseMountPoint()}-Method of the same * MountPointChooser returned a path. * - *

Developers should override this method to prepare the Mountpoint for - * the Volume and check for any obstacles that could hinder the Mount-Operation. - * The Mountpoint is deemed "prepared" if it can be used to mount a Volume - * without any further Filesystemactions or Userinteraction. If this is not possible, + *

Developers should override this method to prepare the mountpoint for + * the volume and check for any obstacles that could hinder the mount operation. + * The mountpoint is deemed "prepared" if it can be used to mount a volume + * without any further filesystem actions or user interaction. If this is not possible, * this method should fail. In other words: This method should not return without - * either failing or finalizing the preparation of the Mountpoint. + * either failing or finalizing the preparation of the mountpoint. * Generally speaking exceptions should be wrapped as * {@link InvalidMountPointException} to allow efficient handling by the caller. * - *

Often the preparation of a Mountpoint involves creating files or others - * actions that require cleaning up after the Volume is unmounted. + *

Often the preparation of a mountpoint involves creating files or others + * actions that require cleaning up after the volume is unmounted. * In this case developers should override the {@link #cleanup(Path)}-Method - * and return {@code true} to the Volume to indicate that the + * and return {@code true} to the volume to indicate that the * {@code #cleanup}-Method of this MPC should be called after unmount. * *

Please note: If this method fails the entire @@ -100,7 +100,7 @@ public interface MountPointChooser extends Comparable { * or any other MPCs. Therefore this method should do all necessary cleanup * before throwing the exception. * - * @param mountPoint the Mountpoint chosen by {@link #chooseMountPoint()} + * @param mountPoint the mountpoint chosen by {@link #chooseMountPoint()} * @return a boolean flag; true if cleanup is needed, false otherwise * @throws InvalidMountPointException if the preparation fails * @see #chooseMountPoint() @@ -118,7 +118,7 @@ public interface MountPointChooser extends Comparable { * delete any files created prior to mount or do similar tasks.
* Exceptions in this method should be handled gracefully. * - * @param mountPoint the Mountpoint that was prepared by {@link #prepare(Path)} + * @param mountPoint the mountpoint that was prepared by {@link #prepare(Path)} * @see #prepare(Path) */ default void cleanup(Path mountPoint) {