Added JavaDocs

Added JavaDocs to various files, namely License, Media, PageTitle, and Utils.
This commit is contained in:
Clay Tsay 2017-12-10 00:28:51 -08:00
parent f1edbfbedd
commit eeea0774b6
4 changed files with 120 additions and 0 deletions

View file

@ -8,6 +8,16 @@ public class License {
private String url; private String url;
private String name; private String name;
/**
* Constructs a new instance of License.
*
* @param key license key
* @param template license template
* @param url license URL
* @param name licence name
*
* @throws RuntimeException if License.key or Licence.template is null
*/
public License(String key, String template, String url, String name) { public License(String key, String template, String url, String name) {
if (key == null) { if (key == null) {
throw new RuntimeException("License.key must not be null"); throw new RuntimeException("License.key must not be null");
@ -21,10 +31,18 @@ public class License {
this.name = name; this.name = name;
} }
/**
* Gets the license key.
* @return license key as a String.
*/
public String getKey() { public String getKey() {
return key; return key;
} }
/**
* Gets the license template.
* @return license template as a String.
*/
public String getTemplate() { public String getTemplate() {
return template; return template;
} }

View file

@ -128,89 +128,179 @@ public class Media implements Parcelable {
return imageUrl; return imageUrl;
} }
/**
* Gets the name of the file.
* @return file name as a string
*/
public String getFilename() { public String getFilename() {
return filename; return filename;
} }
/**
* Sets the name of the file.
* @param filename the new name of the file
*/
public void setFilename(String filename) { public void setFilename(String filename) {
this.filename = filename; this.filename = filename;
} }
/**
* Gets the file description.
* @return file description as a string
*/
public String getDescription() { public String getDescription() {
return description; return description;
} }
/**
* Sets the file description.
* @param description the new description of the file
*/
public void setDescription(String description) { public void setDescription(String description) {
this.description = description; this.description = description;
} }
/**
* Gets the datalength of the file.
* @return file datalength as a long
*/
public long getDataLength() { public long getDataLength() {
return dataLength; return dataLength;
} }
/**
* Sets the datalength of the file.
* @param dataLength as a long
*/
public void setDataLength(long dataLength) { public void setDataLength(long dataLength) {
this.dataLength = dataLength; this.dataLength = dataLength;
} }
/**
* Gets the creation date of the file.
* @return creation date as a Date
*/
public Date getDateCreated() { public Date getDateCreated() {
return dateCreated; return dateCreated;
} }
/**
* Sets the creation date of the file.
* @param date creation date as a Date
*/
public void setDateCreated(Date date) { public void setDateCreated(Date date) {
this.dateCreated = date; this.dateCreated = date;
} }
/**
* Gets the upload date of the file.
* Can be null.
* @return upload date as a Date
*/
public @Nullable public @Nullable
Date getDateUploaded() { Date getDateUploaded() {
return dateUploaded; return dateUploaded;
} }
/**
* Gets the name of the creator of the file.
* @return creator name as a String
*/
public String getCreator() { public String getCreator() {
return creator; return creator;
} }
/**
* Sets the creator name of the file.
* @param creator creator name as a string
*/
public void setCreator(String creator) { public void setCreator(String creator) {
this.creator = creator; this.creator = creator;
} }
/**
* Gets the width of the media.
* @return file width as an int
*/
public int getWidth() { public int getWidth() {
return width; return width;
} }
/**
* Sets the width of the media.
* @param width file width as an int
*/
public void setWidth(int width) { public void setWidth(int width) {
this.width = width; this.width = width;
} }
/**
* Gets the height of the media.
* @return file height as an int
*/
public int getHeight() { public int getHeight() {
return height; return height;
} }
/**
* Sets the height of the media.
* @param height file height as an int
*/
public void setHeight(int height) { public void setHeight(int height) {
this.height = height; this.height = height;
} }
/**
* Gets the license name of the file.
* @return license as a String
*/
public String getLicense() { public String getLicense() {
return license; return license;
} }
/**
* Sets the license name of the file.
* @param license license name as a String
*/
public void setLicense(String license) { public void setLicense(String license) {
this.license = license; this.license = license;
} }
/**
* Gets the coordinates of the file.
* </p>
* Presumably indicates upload location.
* @return file coordinates as a LatLng
*/
public @Nullable public @Nullable
LatLng getCoordinates() { LatLng getCoordinates() {
return coordinates; return coordinates;
} }
/**
* Sets the coordinates of the file.
* @param coordinates file coordinates as a LatLng
*/
public void setCoordinates(@Nullable LatLng coordinates) { public void setCoordinates(@Nullable LatLng coordinates) {
this.coordinates = coordinates; this.coordinates = coordinates;
} }
/**
* Gets the categories the file falls under.
* @return file categories as an ArrayList of Strings
*/
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public ArrayList<String> getCategories() { public ArrayList<String> getCategories() {
return (ArrayList<String>) categories.clone(); // feels dirty return (ArrayList<String>) categories.clone(); // feels dirty
} }
/**
* Sets the categories the file falls under.
* </p>
* Does not append: i.e. will clear the current categories
* and then add the specified ones.
* @param categories file categories as a list of Strings
*/
public void setCategories(List<String> categories) { public void setCategories(List<String> categories) {
this.categories.clear(); this.categories.clear();
this.categories.addAll(categories); this.categories.addAll(categories);

View file

@ -84,6 +84,12 @@ public class PageTitle {
return titleKey; return titleKey;
} }
/**
* Gets the canonicalized title for displaying (such as "File:My example.jpg").
* </p>
* Essentially equivalent to getPrefixedText
* @return canonical title as a String
*/
@Override @Override
public String toString() { public String toString() {
return getPrefixedText(); return getPrefixedText();

View file

@ -51,6 +51,12 @@ public class Utils {
} }
} }
/**
* Capitalizes the first character of a string.
*
* @param string
* @return string with capitalized first character
*/
public static String capitalize(String string) { public static String capitalize(String string) {
return string.substring(0, 1).toUpperCase(Locale.getDefault()) + string.substring(1); return string.substring(0, 1).toUpperCase(Locale.getDefault()) + string.substring(1);
} }