Commits

P_W999 committed b313016

-checkstyle

  • Participants
  • Parent commits 74af933
  • Tags v0.0.6

Comments (0)

Files changed (12)

File src/be/pw/jexif/JExifInfo.java

 	 * Packaged constructor as this object must always be instantiated from an JExifTool instance.
 	 * 
 	 * @param tool the reference to the JExifTool which instantiated this object.
-	 * @param file the image file specified by the user.
+	 * @param imageFile the image file specified by the user.
 	 */
-	JExifInfo(final JExifTool tool, final File file) {
+	JExifInfo(final JExifTool tool, final File imageFile) {
 		this.exifTool = tool;
-		this.file = file;
+		this.file = imageFile;
 	}
 
 	/**

File src/be/pw/jexif/JExifTool.java

 	 * 
 	 * @param file the file from which to read.
 	 * @param tag the tag to read out.
+	 * @param exact whether the exact value should be returned (true) or the human readable format (false)
 	 * @return the tag value as String or null if nothing found.
 	 * @throws JExifException when writing the argsfile went wrong or when the Tread.sleep caused problems (or the execution took to long).
 	 * @throws ExifError if there was a problem in ExifTool

File src/be/pw/jexif/enums/DateTag.java

 public enum DateTag {
 
 	DATETIMEORIGINAL(ExifIFD.DATETIMEORIGINAL), CREATEDATE(ExifIFD.CREATEDATE), MODIFYDATE(IFD0.MODIFYDATE), ALLDATES(null);
-
+	/**
+	 * The tag it represents
+	 */
 	private Tag tag;
 
+	/**
+	 * Hidden constructor.
+	 */
 	private DateTag(final Tag tag) {
 		this.tag = tag;
 	}
 
+	/**
+	 * Returns the Tag representation of a date/time value.
+	 * @return a tag
+	 */
 	public Tag getTag() {
 		return this.tag;
 	}

File src/be/pw/jexif/exception/ExifError.java

  */
 public class ExifError extends Exception {
 
-	public ExifError(final String string) {
-		super(string);
-	}
 
 	/**
-	 * UID
+	 * UID.
 	 */
 	private static final long serialVersionUID = 5564937635541891989L;
+	
+	/**
+	 * Default constructor taking an error message as parameter.
+	 * @param string an error message.
+	 */
+	public ExifError(final String string) {
+		super(string);
+	}
+
 
 }

File src/be/pw/jexif/exception/JExifException.java

 public class JExifException extends Exception {
 
 	/**
-	 * UID
+	 * UID.
 	 */
 	private static final long serialVersionUID = 1768965397370932970L;
 
 	/**
-	 * Hidden constructor to prevent creation of JExifExceptions without information
+	 * Hidden constructor to prevent creation of JExifExceptions without information.
 	 */
 	protected JExifException() {
 		super();

File src/be/pw/jexif/exception/JExifValidationException.java

  * limitations under the License.
  ******************************************************************************/
 package be.pw.jexif.exception;
-
+/**
+ * An exception to be thrown when the validation of an exif value failed.
+ * @author phillip
+ *
+ */
 public class JExifValidationException extends JExifException {
 
 	/**

File src/be/pw/jexif/internal/util/ArrayUtil.java

  * 
  * @author phillip
  */
-public class ArrayUtil {
+public final class ArrayUtil {
+
+	/**
+	 * Hidden constructor.
+	 */
+	private ArrayUtil() {
+	}
+	
 	/**
 	 * Converts an array to a String. Can be usefull for logging purposes.<br />
 	 * The output format of an array with 4 objects is [a,b,c,d] (where a, b, c and d are the 4 objects in the array)<br />

File src/be/pw/jexif/internal/util/Cal10nUtil.java

 public final class Cal10nUtil {
 
 	/**
+	 * Hidden constructor.
+	 */
+	private Cal10nUtil() {
+	}
+	
+	/**
 	 * Logger for this class.
 	 */
 	private static final Logger LOG = LoggerFactory.getLogger(Cal10nUtil.class);
 		mc = new MessageConveyor(l);
 	}
 
-	public static void changeLocale(Locale l) {
+	public static void changeLocale(final Locale l) {
 		Preconditions.checkNotNull(l, "Provided locale can not be null");
-		if (!supportedLanguages.contains(l)) {
-			LOG.info(MessageFormat.format("The locale {0} was not supported, falling back to english", l));
-			l = Locale.ENGLISH;
+		Locale loc = l;
+		if (!supportedLanguages.contains(loc)) {
+			LOG.info(MessageFormat.format("The locale {0} was not supported, falling back to english", loc));
+			loc = Locale.ENGLISH;
 		}
-		mc = new MessageConveyor(l);
+		mc = new MessageConveyor(loc);
 	}
 
 	/**

File src/be/pw/jexif/internal/util/DateUtil.java

  * Generaly utility class for working with dates.
  */
 public final class DateUtil {
+
+	/**
+	 * Hidden constructor.
+	 */
+	private DateUtil() {
+	}
+	
 	/**
 	 * Generates a "YYYY:MM:dd HH:mm:ss.SS XXX" formatted String based on the given date.
 	 * 

File src/be/pw/jexif/internal/util/GPSUtil.java

  * 
  * @author phillip
  */
-public class GPSUtil {
+public final class GPSUtil {
 
 	/**
+	 * Hidden constructor.
+	 */
+	private GPSUtil() {
+	}
+	
+	/**
 	 * Validates that the all mandatory GPS values are provided or that they are all empty. The Map must therefore contain the following Tags:
 	 * <ul>
 	 * <li>{@link ExifGPS#GPSALTITUDE}</li>

File src/be/pw/jexif/internal/util/TagUtil.java

 /**
  * General utility class for working with Tags.
  */
-public class TagUtil {
+public final class TagUtil {
+	
+	/**
+	 * Hidden constructor.
+	 */
+	private TagUtil() {
+	}
+	
 	/**
 	 * Look-up map for quick String-to-Enum conversion.
 	 */

File src/be/pw/jexif/internal/util/TimeShiftGenerator.java

  * 
  */
 public final class TimeShiftGenerator {
+
+	/**
+	 * Hidden constructor.
+	 */
+	private TimeShiftGenerator() {
+	}
+	
 	/**
 	 * Separator between hour, min, sec or year, month, day
 	 */