net.anidb.udp.mask
Class AnimeMask

java.lang.Object
  net.anidb.udp.mask.Mask
      net.anidb.udp.mask.AnimeMask

public class AnimeMask
extends Mask

The anime mask for the ANIME command.

With this mask you can specify which data fields are returned.

Version:

1.0, 06.12.2009

Author:

grizzlyxp (http://anidb.net/perl-bin/animedb.pl?show=userpage&uid=63935)

Field Summary

static AnimeMask

ALL A mask with all fields set.

Constructor Summary

AnimeMask(boolean animeId, boolean year, boolean type, boolean relatedAidList, boolean relatedAidType, boolean categoryList, boolean categoryWeightList, boolean romajiName, boolean kanjiName, boolean englishName, boolean otherNames, boolean shortNameList, boolean synonymList, boolean episodes, boolean normalEpisodeCount, boolean specialEpisodeCount, boolean airDate, boolean endDate, boolean url, boolean picname, boolean categoryIdList, boolean rating, boolean voteCount, boolean tempRating, boolean tempVoteCount, boolean averageReviewRating, boolean reviewCount, boolean awardList, boolean is18PlusRestricted, boolean animePlanetId, boolean annId, boolean allCinemaId, boolean animeNfoId, boolean dateRecordUpdated, boolean characterIdList, boolean creatorIdList, boolean producerIdList, boolean producerNameList, boolean specialsCount, boolean creditsCount, boolean otherCount, boolean trailerCount, boolean parodyCount)
Creates an anime mask.

Method Summary

boolean	equals(java.lang.Object obj)
int	getFlagCount() Returns the count how many flags are set.
java.lang.String	getHexMask() Returns the mask as a hex value.
long	getMask() Returns the mask as a value.
int	hashCode()
boolean	is18PlusRestricted() Returns the 'is 18+ restricted' flag.
boolean	isAirDate() Returns the air date.
boolean	isAllCinemaId() Return ths AllCinema Id.
boolean	isAnimeId() Returns the anime Id.
boolean	isAnimeNfoId() Returns the AnimeNfo Id.
boolean	isAnimePlanetId() Returns the Anime Planet Id.
boolean	isAnnId() Returns the Ann Id.
boolean	isAverageReviewRating() Returns the average review rating.
boolean	isAwardList() Returns the award list.
boolean	isCategoryIdList() Returns the category Id list.
boolean	isCategoryList() Returns the category list.
boolean	isCategoryWeightList() Returns the category weight list.
boolean	isCharacterIdList() Returns the character Id list.
boolean	isCreatorIdList() Returns the creator Id list.
boolean	isCreditsCount() Returns the credits count.
boolean	isDateRecordUpdated() Returns the record update date.
boolean	isEndDate() Returns the end date.
boolean	isEnglishName() Returns the english name.
boolean	isEpisodes() Returns the number of episodes.
boolean	isKanjiName() Returns the kanji name.
boolean	isNormalEpisodeCount() Returns the normal episode count.
boolean	isOtherCount() Returns the other count.
boolean	isOtherNames() Returns the other names list.
boolean	isParodyCount() Returns the parody count.
boolean	isPicname() Returns the picname.
boolean	isProducerIdList() Returns the producer Id list.
boolean	isProducerNameList() Returns the producer name list.
boolean	isRating() Returns the rating.
boolean	isRelatedAidList() Returns the related anime Id list.
boolean	isRelatedAidType() Returns the related anime type.
boolean	isReviewCount() Returns the review count.
boolean	isRomajiName() Returns the romaji name.
boolean	isShortNameList() Returns the short name list.
boolean	isSpecialEpisodeCount() Returns the special episode count.
boolean	isSpecialsCount() Returns the specials count.
boolean	isSynonymList() Returns the synonym list.
boolean	isTempRating() Returns the temporary rating.
boolean	isTempVoteCount() Returns the temporary vote count.
boolean	isTrailerCount() Returns the trailer count.
boolean	isType() Returns the type.
boolean	isUrl() Returns the url.
boolean	isVoteCount() Returns the vote count.
boolean	isYear() Returns the year.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL

public static final AnimeMask ALL

A mask with all fields set.

Constructor Detail

AnimeMask

public AnimeMask(boolean animeId,
                 boolean year,
                 boolean type,
                 boolean relatedAidList,
                 boolean relatedAidType,
                 boolean categoryList,
                 boolean categoryWeightList,
                 boolean romajiName,
                 boolean kanjiName,
                 boolean englishName,
                 boolean otherNames,
                 boolean shortNameList,
                 boolean synonymList,
                 boolean episodes,
                 boolean normalEpisodeCount,
                 boolean specialEpisodeCount,
                 boolean airDate,
                 boolean endDate,
                 boolean url,
                 boolean picname,
                 boolean categoryIdList,
                 boolean rating,
                 boolean voteCount,
                 boolean tempRating,
                 boolean tempVoteCount,
                 boolean averageReviewRating,
                 boolean reviewCount,
                 boolean awardList,
                 boolean is18PlusRestricted,
                 boolean animePlanetId,
                 boolean annId,
                 boolean allCinemaId,
                 boolean animeNfoId,
                 boolean dateRecordUpdated,
                 boolean characterIdList,
                 boolean creatorIdList,
                 boolean producerIdList,
                 boolean producerNameList,
                 boolean specialsCount,
                 boolean creditsCount,
                 boolean otherCount,
                 boolean trailerCount,
                 boolean parodyCount)

Creates an anime mask.

Parameters:

animeId - The anime Id.

year - The year.

type - The type.

relatedAidList - The related anime Id list.

relatedAidType - The related anime type.

categoryList - The category list.

categoryWeightList - The category weight list.

romajiName - The romaji name.

kanjiName - The kanji name.

englishName - The english name.

otherNames - The other names list.

shortNameList - The short name list.

synonymList - The synonym list.

episodes - The number of episodes.

normalEpisodeCount - The normal episode count.

specialEpisodeCount - The special episode count.

airDate - The air date.

endDate - The end date.

url - The url.

picname - The picname.

categoryIdList - The category Id list.

rating - The rating.

voteCount - The vote count.

tempRating - The temporary rating.

tempVoteCount - The temporary vote count.

averageReviewRating - The average review rating.

reviewCount - The review count.

awardList - The award list.

is18PlusRestricted - The 'is 18+ restricted' flag.

animePlanetId - The Anime Planet Id.

annId - The Ann Id.

allCinemaId - The AllCinema Id.

animeNfoId - The AnimeNfo Id.

dateRecordUpdated - The record update date.

characterIdList - The character Id list.

creatorIdList - The creator Id list.

producerIdList - The producer Id list.

producerNameList - The producer name list.

specialsCount - The specials count.

creditsCount - The credits count.

otherCount - The other count.

trailerCount - The trailer count.

parodyCount - The parody count.

Method Detail

isAnimeId

public boolean isAnimeId()

Returns the anime Id.

Returns:

The anime Id.

isYear

public boolean isYear()

Returns the year.

Returns:

The year.

isType

public boolean isType()

Returns the type.

Returns:

The typ.

isRelatedAidList

public boolean isRelatedAidList()

Returns the related anime Id list.

Returns:

The related anime Id list.

isRelatedAidType

public boolean isRelatedAidType()

Returns the related anime type.

Returns:

The related anime type.

isCategoryList

public boolean isCategoryList()

Returns the category list.

Returns:

The category list.

isCategoryWeightList

public boolean isCategoryWeightList()

Returns the category weight list.

Returns:

The category weight list.

isRomajiName

public boolean isRomajiName()

Returns the romaji name.

Returns:

The romaji name.

isKanjiName

public boolean isKanjiName()

Returns the kanji name.

Returns:

The kanji name.

isEnglishName

public boolean isEnglishName()

Returns the english name.

Returns:

The english name.

isOtherNames

public boolean isOtherNames()

Returns the other names list.

Returns:

The other names list.

isShortNameList

public boolean isShortNameList()

Returns the short name list.

Returns:

The short name list.

isSynonymList

public boolean isSynonymList()

Returns the synonym list.

Returns:

The synonym list.

isEpisodes

public boolean isEpisodes()

Returns the number of episodes.

Returns:

The number of episodes.

isNormalEpisodeCount

public boolean isNormalEpisodeCount()

Returns the normal episode count.

Returns:

The normal episode count.

isSpecialEpisodeCount

public boolean isSpecialEpisodeCount()

Returns the special episode count.

Returns:

The special episode count.

isAirDate

public boolean isAirDate()

Returns the air date.

Returns:

The air date.

isEndDate

public boolean isEndDate()

Returns the end date.

Returns:

The end date.

isUrl

public boolean isUrl()

Returns the url.

Returns:

The url.

isPicname

public boolean isPicname()

Returns the picname.

Returns:

The picname.

isCategoryIdList

public boolean isCategoryIdList()

Returns the category Id list.

Returns:

The category Id list.

isRating

public boolean isRating()

Returns the rating.

Returns:

The rating.

isVoteCount

public boolean isVoteCount()

Returns the vote count.

Returns:

The vote count.

isTempRating

public boolean isTempRating()

Returns the temporary rating.

Returns:

The temporary rating.

isTempVoteCount

public boolean isTempVoteCount()

Returns the temporary vote count.

Returns:

The temporary vote count.

isAverageReviewRating

public boolean isAverageReviewRating()

Returns the average review rating.

Returns:

The average review rating.

isReviewCount

public boolean isReviewCount()

Returns the review count.

Returns:

The review count.

isAwardList

public boolean isAwardList()

Returns the award list.

Returns:

The award list.

is18PlusRestricted

public boolean is18PlusRestricted()

Returns the 'is 18+ restricted' flag.

Returns:

The 'is 18+ restricted' flag.

isAnimePlanetId

public boolean isAnimePlanetId()

Returns the Anime Planet Id.

Returns:

The Anime Planet Id.

isAnnId

public boolean isAnnId()

Returns the Ann Id.

Returns:

The Ann Id.

isAllCinemaId

public boolean isAllCinemaId()

Return ths AllCinema Id.

Returns:

The AllCinema Id.

isAnimeNfoId

public boolean isAnimeNfoId()

Returns the AnimeNfo Id.

Returns:

The AnimeNfo Id.

isDateRecordUpdated

public boolean isDateRecordUpdated()

Returns the record update date.

Returns:

The record update date.

isCharacterIdList

public boolean isCharacterIdList()

Returns the character Id list.

Returns:

The character Id list

isCreatorIdList

public boolean isCreatorIdList()

Returns the creator Id list.

Returns:

The creator Id list.

isProducerIdList

public boolean isProducerIdList()

Returns the producer Id list.

Returns:

The producer Id list.

isProducerNameList

public boolean isProducerNameList()

Returns the producer name list.

Returns:

The producer name list.

isSpecialsCount

public boolean isSpecialsCount()

Returns the specials count.

Returns:

The specials count.

isCreditsCount

public boolean isCreditsCount()

Returns the credits count.

Returns:

The credits count.

isOtherCount

public boolean isOtherCount()

Returns the other count.

Returns:

The other count.

isTrailerCount

public boolean isTrailerCount()

Returns the trailer count.

Returns:

The trailer count.

isParodyCount

public boolean isParodyCount()

Returns the parody count.

Returns:

The parody count.

getMask

public long getMask()

Description copied from class: Mask

Returns the mask as a value.

Specified by:

getMask in class Mask

Returns:

The value.

getHexMask

public java.lang.String getHexMask()

Description copied from class: Mask

Returns the mask as a hex value.

The hex value will allways have the constant and full length.

Specified by:

getHexMask in class Mask

Returns:

The hex value.

getFlagCount

public int getFlagCount()

Description copied from class: Mask

Returns the count how many flags are set.

Specified by:

getFlagCount in class Mask

Returns:

The count.

hashCode

public int hashCode()

Specified by:

hashCode in class Mask

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in class Mask