Commit d0968129 authored by Matija Obreza's avatar Matija Obreza
Browse files

Added missing Javadoc

parent 742030d7
......@@ -87,6 +87,13 @@ public interface RepositoryService {
*/
byte[] getFileBytes(String repositoryPath, String filename) throws NoSuchRepositoryFileException;
/**
* Gets the file bytes.
*
* @param repositoryFile the repository file
* @return the file bytes
* @throws IOException Signals that an I/O exception has occurred.
*/
byte[] getFileBytes(RepositoryFile repositoryFile) throws IOException;
/**
......@@ -180,11 +187,12 @@ public interface RepositoryService {
RepositoryImage updateImageMetadata(UUID uuid, RepositoryImageData imageData) throws NoSuchRepositoryFileException;
/**
* Remove repository image
* Remove repository image.
*
* @param repositoryImage
* @param repositoryImage the repository image
* @return the original metadata
* @throws NoSuchRepositoryFileException when file is not available in the repository
* @throws IOException Signals that an I/O exception has occurred.
*/
RepositoryImage removeImage(RepositoryImage repositoryImage) throws NoSuchRepositoryFileException, IOException;
......
......@@ -24,7 +24,7 @@ public class FilenameValidator {
/**
* Checks if the filename is acceptable.
*
* @param filename
* @param filename the filename
* @return true when OK, false otherwise.
*/
public static boolean isValidFilename(final String filename) {
......
......@@ -19,7 +19,7 @@ package org.genesys2.server.filerepository.service.impl;
import org.genesys2.server.filerepository.InvalidRepositoryPathException;
/**
* Simple path validator
* Simple path validator.
*/
public class PathValidator {
/**
......@@ -34,9 +34,9 @@ public class PathValidator {
}
/**
* Checks if path is valid and throws InvalidPathException when path is not valid
* Checks if path is valid and throws InvalidPathException when path is not valid.
*
* @param path
* @param path the path
* @throws InvalidRepositoryPathException when path is not valid.
*/
public static void checkValidPath(final String path) throws InvalidRepositoryPathException {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment