diff options
Diffstat (limited to 'src/main/java/com/pinapelz/query')
6 files changed, 823 insertions, 1 deletions
diff --git a/src/main/java/com/pinapelz/query/ChannelQueryBuilder.java b/src/main/java/com/pinapelz/query/ChannelQueryBuilder.java index 329427c..c071497 100644 --- a/src/main/java/com/pinapelz/query/ChannelQueryBuilder.java +++ b/src/main/java/com/pinapelz/query/ChannelQueryBuilder.java @@ -9,6 +9,9 @@ import java.util.List; /** * Query builder for getting a list of Channels matching the given parameters + * + * @author pinapelz + * @version $Id: $Id */ public class ChannelQueryBuilder { private Integer limit; @@ -19,47 +22,103 @@ public class ChannelQueryBuilder { private String org; private String sort; + /** + * <p>Getter for the field <code>limit</code>.</p> + * + * @return a {@link java.lang.Integer} object. + */ public Integer getLimit() { return limit; } + /** + * <p>Setter for the field <code>limit</code>.</p> + * + * @param limit a {@link java.lang.Integer} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setLimit(Integer limit) { this.limit = limit; return this; } + /** + * <p>Getter for the field <code>offset</code>.</p> + * + * @return a {@link java.lang.Integer} object. + */ public Integer getOffset() { return offset; } + /** + * <p>Setter for the field <code>offset</code>.</p> + * + * @param offset a {@link java.lang.Integer} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setOffset(Integer offset) { this.offset = offset; return this; } + /** + * <p>Getter for the field <code>type</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getType() { return type; } + /** + * <p>Setter for the field <code>type</code>.</p> + * + * @param type a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setType(String type) { this.type = type; return this; } + /** + * <p>Getter for the field <code>lang</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getLang() { return lang; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setLang(String lang) { this.lang = lang; return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link com.pinapelz.vtuber.Language} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setLang(Language lang) { this.lang = lang.toString(); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param language a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setLang(List<Language> language) { String[] languages = new String[language.size()]; for (int i = 0; i < language.size(); i++) { @@ -69,43 +128,94 @@ public class ChannelQueryBuilder { return this; } + /** + * <p>Getter for the field <code>order</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getOrder() { return order; } + /** + * <p>Setter for the field <code>order</code>.</p> + * + * @param order a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setOrder(String order) { this.order = order; return this; } + /** + * <p>Setter for the field <code>order</code>.</p> + * + * @param order a {@link com.pinapelz.vtuber.Order} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setOrder(Order order){ this.order = order.toString(); return this; } + /** + * <p>Getter for the field <code>org</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getOrg() { return org; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setOrg(String org) { this.org = org; return this; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link com.pinapelz.vtuber.Organization} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setOrg(Organization org) { this.org = org.toString(); return this; } + /** + * <p>Getter for the field <code>sort</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getSort() { return sort; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setSort(String sort) { this.sort = sort; return this; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link com.pinapelz.vtuber.Sort} object. + * @return a {@link com.pinapelz.query.ChannelQueryBuilder} object. + */ public ChannelQueryBuilder setSort(Sort sort){ this.sort = sort.toString(); return this; diff --git a/src/main/java/com/pinapelz/query/CommentSearchQueryBuilder.java b/src/main/java/com/pinapelz/query/CommentSearchQueryBuilder.java index 6c1fa90..df96256 100644 --- a/src/main/java/com/pinapelz/query/CommentSearchQueryBuilder.java +++ b/src/main/java/com/pinapelz/query/CommentSearchQueryBuilder.java @@ -11,6 +11,9 @@ import java.util.List; /** * Builder for a comment search query * Default values set in constructor + * + * @author pinapelz + * @version $Id: $Id */ public class CommentSearchQueryBuilder { private String sort; @@ -25,6 +28,9 @@ public class CommentSearchQueryBuilder { private int limit; private List<String> lang; + /** + * <p>Constructor for CommentSearchQueryBuilder.</p> + */ public CommentSearchQueryBuilder(){ this.sort = "newest"; this.paginated = true; @@ -38,34 +44,74 @@ public class CommentSearchQueryBuilder { this.lang = List.of("en"); } + /** + * <p>Getter for the field <code>sort</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getSort() { return sort; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setSort(String sort) { this.sort = sort; return this; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link com.pinapelz.vtuber.Sort} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setSort(Sort sort) { this.sort = sort.toString(); return this; } + /** + * <p>Getter for the field <code>lang</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getLang() { return lang; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setLang(String lang) { this.lang = List.of(lang); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link com.pinapelz.vtuber.Language} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setLang(Language lang) { this.lang = List.of(lang.toString()); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param language an array of {@link com.pinapelz.vtuber.Language} objects. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setLang(Language[] language) { List<String> lang = new ArrayList<String>(); for (Language l : language) { @@ -75,20 +121,43 @@ public class CommentSearchQueryBuilder { return this; } + /** + * <p>Getter for the field <code>target</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getTarget() { return target; } + /** + * <p>Setter for the field <code>target</code>.</p> + * + * @param target a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setTarget(String target) { this.target = List.of(target); return this; } + /** + * <p>Setter for the field <code>target</code>.</p> + * + * @param target a {@link com.pinapelz.vtuber.Type} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setTarget(Type target) { this.target = List.of(target.toString()); return this; } + /** + * <p>Setter for the field <code>target</code>.</p> + * + * @param target a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setTarget(List<Type> target) { List<String> targets = new ArrayList<String>(); for (Type t : target) { @@ -100,47 +169,103 @@ public class CommentSearchQueryBuilder { + /** + * <p>Getter for the field <code>conditions</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getConditions() { return conditions; } + /** + * <p>Setter for the field <code>conditions</code>.</p> + * + * @param conditions a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setConditions(List<String> conditions) { this.conditions = conditions; return this; } + /** + * <p>Getter for the field <code>topic</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getTopic() { return topic; } + /** + * <p>Setter for the field <code>topic</code>.</p> + * + * @param topic a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setTopic(List<String> topic) { this.topic = topic; return this; } + /** + * <p>Getter for the field <code>vch</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getVch() { return vch; } + /** + * <p>Setter for the field <code>vch</code>.</p> + * + * @param vch a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setVch(List<String> vch) { this.vch = vch; return this; } + /** + * <p>Getter for the field <code>org</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getOrg() { return org; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setOrg(String org) { this.org = List.of(org); return this; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link com.pinapelz.vtuber.Organization} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setOrg(Organization org) { this.org = List.of(org.toString()); return this; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setOrg(List<Organization> org) { List<String> orgs = new ArrayList<String>(); for (Organization o : org) { @@ -151,37 +276,81 @@ public class CommentSearchQueryBuilder { } + /** + * <p>Getter for the field <code>comment</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getComment() { return comment; } + /** + * <p>Setter for the field <code>comment</code>.</p> + * + * @param comment a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setComment(List<String> comment) { this.comment = comment; return this; } + /** + * <p>isPaginated.</p> + * + * @return a boolean. + */ public boolean isPaginated() { return paginated; } + /** + * <p>Setter for the field <code>paginated</code>.</p> + * + * @param paginated a boolean. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setPaginated(boolean paginated) { this.paginated = paginated; return this; } + /** + * <p>Getter for the field <code>offset</code>.</p> + * + * @return a int. + */ public int getOffset() { return offset; } + /** + * <p>Setter for the field <code>offset</code>.</p> + * + * @param offset a int. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setOffset(int offset) { this.offset = offset; return this; } + /** + * <p>Getter for the field <code>limit</code>.</p> + * + * @return a int. + */ public int getLimit() { return limit; } + /** + * <p>Setter for the field <code>limit</code>.</p> + * + * @param limit a int. + * @return a {@link com.pinapelz.query.CommentSearchQueryBuilder} object. + */ public CommentSearchQueryBuilder setLimit(int limit) { this.limit = limit; return this; diff --git a/src/main/java/com/pinapelz/query/VideoByVideoIdQueryBuilder.java b/src/main/java/com/pinapelz/query/VideoByVideoIdQueryBuilder.java index 6729916..56d51b6 100644 --- a/src/main/java/com/pinapelz/query/VideoByVideoIdQueryBuilder.java +++ b/src/main/java/com/pinapelz/query/VideoByVideoIdQueryBuilder.java @@ -7,36 +7,73 @@ import java.util.List; /** * Query builder for getting a video by video id + * + * @author pinapelz + * @version $Id: $Id */ public class VideoByVideoIdQueryBuilder { private String videoId; private String lang; private String c; + /** + * <p>Getter for the field <code>videoId</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getVideoId() { return videoId; } + /** + * <p>Setter for the field <code>videoId</code>.</p> + * + * @param videoId a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoByVideoIdQueryBuilder} object. + */ public VideoByVideoIdQueryBuilder setVideoId(String videoId) { this.videoId = videoId; return this; } + /** + * <p>Getter for the field <code>lang</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getLang() { return lang; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoByVideoIdQueryBuilder} object. + */ public VideoByVideoIdQueryBuilder setLang(String lang) { this.lang = lang; return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link com.pinapelz.vtuber.Language} object. + * @return a {@link com.pinapelz.query.VideoByVideoIdQueryBuilder} object. + */ public VideoByVideoIdQueryBuilder setLang(Language lang) { this.lang = lang.toString(); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param language a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoByVideoIdQueryBuilder} object. + */ public VideoByVideoIdQueryBuilder setLang(List<Language> language) { String[] languages = new String[language.size()]; for (int i = 0; i < language.size(); i++) { @@ -46,10 +83,21 @@ public class VideoByVideoIdQueryBuilder { return this; } + /** + * <p>Getter for the field <code>c</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getC() { return c; } + /** + * <p>Setter for the field <code>c</code>.</p> + * + * @param c a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoByVideoIdQueryBuilder} object. + */ public VideoByVideoIdQueryBuilder setC(String c) { this.c = c; return this; diff --git a/src/main/java/com/pinapelz/query/VideoQueryBuilder.java b/src/main/java/com/pinapelz/query/VideoQueryBuilder.java index 6a74217..56555a2 100644 --- a/src/main/java/com/pinapelz/query/VideoQueryBuilder.java +++ b/src/main/java/com/pinapelz/query/VideoQueryBuilder.java @@ -8,6 +8,9 @@ import java.util.List; /** * Query builder for getting a set of videos matching the given parameters + * + * @author pinapelz + * @version $Id: $Id */ public class VideoQueryBuilder { private String channelId; @@ -26,26 +29,56 @@ public class VideoQueryBuilder { private String topic; private String type; + /** + * <p>Setter for the field <code>channelId</code>.</p> + * + * @param channelId a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setChannelId(String channelId) { this.channelId = channelId; return this; } + /** + * <p>Setter for the field <code>id</code>.</p> + * + * @param id a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setId(String id) { this.id = id; return this; } + /** + * <p>Setter for the field <code>include</code>.</p> + * + * @param include a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setInclude(String include) { this.include = include; return this; } + /** + * <p>Setter for the field <code>include</code>.</p> + * + * @param include a {@link com.pinapelz.vtuber.ExtraData} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setInclude(ExtraData include) { this.include = include.toString(); return this; } + /** + * <p>Setter for the field <code>include</code>.</p> + * + * @param include a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setInclude(List<ExtraData> include){ String[] includeStrings = new String[include.size()]; for (int i = 0; i < include.size(); i++) { @@ -55,16 +88,34 @@ public class VideoQueryBuilder { return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setLang(String lang) { this.lang = lang; return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link com.pinapelz.vtuber.Language} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setLang(Language lang) { this.lang = lang.toString(); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setLang(List<Language> lang) { String[] langStrings = new String[lang.size()]; for (int i = 0; i < lang.size(); i++) { @@ -75,138 +126,303 @@ public class VideoQueryBuilder { } + /** + * <p>Setter for the field <code>limit</code>.</p> + * + * @param limit a {@link java.lang.Integer} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setLimit(Integer limit) { this.limit = limit; return this; } + /** + * <p>Setter for the field <code>maxUpcomingHours</code>.</p> + * + * @param maxUpcomingHours a {@link java.lang.Integer} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setMaxUpcomingHours(Integer maxUpcomingHours) { this.maxUpcomingHours = maxUpcomingHours; return this; } + /** + * <p>Setter for the field <code>mentionedChannelId</code>.</p> + * + * @param mentionedChannelId a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setMentionedChannelId(String mentionedChannelId) { this.mentionedChannelId = mentionedChannelId; return this; } + /** + * <p>Setter for the field <code>offset</code>.</p> + * + * @param offset a {@link java.lang.Integer} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setOffset(Integer offset) { this.offset = offset; return this; } + /** + * <p>Setter for the field <code>order</code>.</p> + * + * @param order a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setOrder(String order) { this.order = order; return this; } + /** + * <p>Setter for the field <code>order</code>.</p> + * + * @param order a {@link com.pinapelz.vtuber.Order} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setOrder(Order order) { this.order = order.toString(); return this; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setOrg(String org) { this.org = org; return this; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link com.pinapelz.vtuber.Organization} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setOrg(Organization org) { this.org = org.toString(); return this; } + /** + * <p>Setter for the field <code>paginated</code>.</p> + * + * @param paginated a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setPaginated(String paginated) { this.paginated = paginated; return this; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setSort(String sort) { this.sort = sort; return this; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link com.pinapelz.vtuber.Sort} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setSort(Sort sort) { this.sort = sort.toString(); return this; } + /** + * <p>Setter for the field <code>status</code>.</p> + * + * @param status a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setStatus(String status) { this.status = status; return this; } + /** + * <p>Setter for the field <code>status</code>.</p> + * + * @param status a {@link com.pinapelz.vtuber.Status} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setStatus(Status status) { this.status = status.toString(); return this; } + /** + * <p>Setter for the field <code>topic</code>.</p> + * + * @param topic a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setTopic(String topic) { this.topic = topic; return this; } + /** + * <p>Setter for the field <code>type</code>.</p> + * + * @param type a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoQueryBuilder} object. + */ public VideoQueryBuilder setType(String type) { this.type = type; return this; } + /** + * <p>Getter for the field <code>channelId</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getChannelId() { return channelId; } + /** + * <p>Getter for the field <code>id</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getId() { return id; } + /** + * <p>Getter for the field <code>include</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getInclude() { return include; } + /** + * <p>Getter for the field <code>lang</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getLang() { return lang; } + /** + * <p>Getter for the field <code>limit</code>.</p> + * + * @return a {@link java.lang.Integer} object. + */ public Integer getLimit() { return limit; } + /** + * <p>Getter for the field <code>maxUpcomingHours</code>.</p> + * + * @return a {@link java.lang.Integer} object. + */ public Integer getMaxUpcomingHours() { return maxUpcomingHours; } + /** + * <p>Getter for the field <code>mentionedChannelId</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getMentionedChannelId() { return mentionedChannelId; } + /** + * <p>Getter for the field <code>offset</code>.</p> + * + * @return a {@link java.lang.Integer} object. + */ public Integer getOffset() { return offset; } + /** + * <p>Getter for the field <code>order</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getOrder() { return order; } + /** + * <p>Getter for the field <code>org</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getOrg() { return org; } + /** + * <p>Getter for the field <code>paginated</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getPaginated() { return paginated; } + /** + * <p>Getter for the field <code>sort</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getSort() { return sort; } + /** + * <p>Getter for the field <code>status</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getStatus() { return status; } + /** + * <p>Getter for the field <code>topic</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getTopic() { return topic; } + /** + * <p>Getter for the field <code>type</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getType() { return type; } -}
\ No newline at end of file +} diff --git a/src/main/java/com/pinapelz/query/VideoSearchQueryBuilder.java b/src/main/java/com/pinapelz/query/VideoSearchQueryBuilder.java index 0a42716..eebcaa2 100644 --- a/src/main/java/com/pinapelz/query/VideoSearchQueryBuilder.java +++ b/src/main/java/com/pinapelz/query/VideoSearchQueryBuilder.java @@ -11,6 +11,9 @@ import java.util.List; /** * Builder for a video search query * Default values set in constructor + * + * @author pinapelz + * @version $Id: $Id */ public class VideoSearchQueryBuilder { private String sort; @@ -25,6 +28,9 @@ public class VideoSearchQueryBuilder { private int offset; private int limit; + /** + * <p>Constructor for VideoSearchQueryBuilder.</p> + */ public VideoSearchQueryBuilder() { this.sort = "newest"; this.paginated = true; @@ -38,53 +44,116 @@ public class VideoSearchQueryBuilder { this.lang = List.of("en"); } + /** + * <p>Getter for the field <code>sort</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getSort() { return sort; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setSort(String sort) { this.sort = sort; return this; } + /** + * <p>Setter for the field <code>sort</code>.</p> + * + * @param sort a {@link com.pinapelz.vtuber.Sort} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setSort(Sort sort) { this.sort = sort.toString(); return this; } + /** + * <p>Getter for the field <code>lang</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getLang() { return lang; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setLang(String lang) { this.lang = List.of(lang); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link com.pinapelz.vtuber.Language} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setLang(Language lang) { this.lang = List.of(lang.toString()); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param language a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setLang(List<String> language) { this.lang = language; return this; } + /** + * <p>Getter for the field <code>target</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getTarget() { return target; } + /** + * <p>Setter for the field <code>target</code>.</p> + * + * @param target a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setTarget(String target) { this.target = List.of(target); return this; } + /** + * <p>Setter for the field <code>target</code>.</p> + * + * @param target a {@link com.pinapelz.vtuber.Type} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setTarget(Type target) { this.target = List.of(target.toString()); return this; } + /** + * <p>Setter for the field <code>target</code>.</p> + * + * @param target a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setTarget(List<Type> target) { List<String> targets = new ArrayList<String>(); for (Type t : target) { @@ -95,47 +164,103 @@ public class VideoSearchQueryBuilder { } + /** + * <p>Getter for the field <code>conditions</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getConditions() { return conditions; } + /** + * <p>Setter for the field <code>conditions</code>.</p> + * + * @param conditions a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setConditions(List<String> conditions) { this.conditions = conditions; return this; } + /** + * <p>Getter for the field <code>topic</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getTopic() { return topic; } + /** + * <p>Setter for the field <code>topic</code>.</p> + * + * @param topic a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setTopic(List<String> topic) { this.topic = topic; return this; } + /** + * <p>Getter for the field <code>vch</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getVch() { return vch; } + /** + * <p>Setter for the field <code>vch</code>.</p> + * + * @param vch a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setVch(List<String> vch) { this.vch = vch; return this; } + /** + * <p>Getter for the field <code>org</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getOrg() { return org; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setOrg(String org) { this.org = List.of(org); return this; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link com.pinapelz.vtuber.Organization} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setOrg(Organization org) { this.org = List.of(org.toString()); return this; } + /** + * <p>Setter for the field <code>org</code>.</p> + * + * @param org a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setOrg(List<Organization> org) { List<String> orgs = new ArrayList<String>(); for (Organization o : org) { @@ -145,37 +270,81 @@ public class VideoSearchQueryBuilder { return this; } + /** + * <p>Getter for the field <code>comment</code>.</p> + * + * @return a {@link java.util.List} object. + */ public List<String> getComment() { return comment; } + /** + * <p>Setter for the field <code>comment</code>.</p> + * + * @param comment a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setComment(List<String> comment) { this.comment = comment; return this; } + /** + * <p>isPaginated.</p> + * + * @return a boolean. + */ public boolean isPaginated() { return paginated; } + /** + * <p>Setter for the field <code>paginated</code>.</p> + * + * @param paginated a boolean. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setPaginated(boolean paginated) { this.paginated = paginated; return this; } + /** + * <p>Getter for the field <code>offset</code>.</p> + * + * @return a int. + */ public int getOffset() { return offset; } + /** + * <p>Setter for the field <code>offset</code>.</p> + * + * @param offset a int. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setOffset(int offset) { this.offset = offset; return this; } + /** + * <p>Getter for the field <code>limit</code>.</p> + * + * @return a int. + */ public int getLimit() { return limit; } + /** + * <p>Setter for the field <code>limit</code>.</p> + * + * @param limit a int. + * @return a {@link com.pinapelz.query.VideoSearchQueryBuilder} object. + */ public VideoSearchQueryBuilder setLimit(int limit) { this.limit = limit; return this; diff --git a/src/main/java/com/pinapelz/query/VideosByChannelIDQueryBuilder.java b/src/main/java/com/pinapelz/query/VideosByChannelIDQueryBuilder.java index 9047f1a..980969c 100644 --- a/src/main/java/com/pinapelz/query/VideosByChannelIDQueryBuilder.java +++ b/src/main/java/com/pinapelz/query/VideosByChannelIDQueryBuilder.java @@ -7,6 +7,9 @@ import java.util.List; /** * Query builder for getting videos by a given channel id + * + * @author pinapelz + * @version $Id: $Id */ public class VideosByChannelIDQueryBuilder { private String channelId; @@ -17,26 +20,56 @@ public class VideosByChannelIDQueryBuilder { private Integer offset; private String paginated; + /** + * <p>Setter for the field <code>channelId</code>.</p> + * + * @param channelId a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setChannelId(String channelId) { this.channelId = channelId; return this; } + /** + * <p>Setter for the field <code>type</code>.</p> + * + * @param type a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setType(String type) { this.type = type; return this; } + /** + * <p>Setter for the field <code>include</code>.</p> + * + * @param include a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setInclude(String include) { this.include = include; return this; } + /** + * <p>Setter for the field <code>include</code>.</p> + * + * @param include an array of {@link java.lang.String} objects. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setInclude(String[] include) { this.include = String.join(",", include); return this; } + /** + * <p>Setter for the field <code>include</code>.</p> + * + * @param include an array of {@link com.pinapelz.vtuber.ExtraData} objects. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setInclude(ExtraData[] include) { String[] includeStrings = new String[include.length]; for (int i = 0; i < include.length; i++) { @@ -46,6 +79,12 @@ public class VideosByChannelIDQueryBuilder { return this; } + /** + * <p>Setter for the field <code>include</code>.</p> + * + * @param include a {@link com.pinapelz.vtuber.ExtraData} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setInclude(ExtraData include) { this.include = include.toString(); return this; @@ -53,16 +92,34 @@ public class VideosByChannelIDQueryBuilder { + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setLang(String lang) { this.lang = lang; return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link com.pinapelz.vtuber.Language} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setLang(Language lang) { this.lang = lang.toString(); return this; } + /** + * <p>Setter for the field <code>lang</code>.</p> + * + * @param lang a {@link java.util.List} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setLang(List<Language> lang){ String[] langStrings = new String[lang.size()]; for (int i = 0; i < lang.size(); i++) { @@ -72,45 +129,98 @@ public class VideosByChannelIDQueryBuilder { return this; } + /** + * <p>Setter for the field <code>limit</code>.</p> + * + * @param limit a {@link java.lang.Integer} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setLimit(Integer limit) { this.limit = limit; return this; } + /** + * <p>Setter for the field <code>offset</code>.</p> + * + * @param offset a {@link java.lang.Integer} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setOffset(Integer offset) { this.offset = offset; return this; } + /** + * <p>Setter for the field <code>paginated</code>.</p> + * + * @param paginated a {@link java.lang.String} object. + * @return a {@link com.pinapelz.query.VideosByChannelIDQueryBuilder} object. + */ public VideosByChannelIDQueryBuilder setPaginated(String paginated) { this.paginated = paginated; return this; } + /** + * <p>Getter for the field <code>channelId</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getChannelId() { return channelId; } + /** + * <p>Getter for the field <code>type</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getType() { return type; } + /** + * <p>Getter for the field <code>include</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getInclude() { return include; } + /** + * <p>Getter for the field <code>lang</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getLang() { return lang; } + /** + * <p>Getter for the field <code>limit</code>.</p> + * + * @return a {@link java.lang.Integer} object. + */ public Integer getLimit() { return limit; } + /** + * <p>Getter for the field <code>offset</code>.</p> + * + * @return a {@link java.lang.Integer} object. + */ public Integer getOffset() { return offset; } + /** + * <p>Getter for the field <code>paginated</code>.</p> + * + * @return a {@link java.lang.String} object. + */ public String getPaginated() { return paginated; } |