net.anidb.udp.mask
Class AnimeFileMask

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

public class AnimeFileMask
extends Mask

The anime mask for the FILE command.

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

Version:

1.0, 07.12.2009

Author:

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

Field Summary

static AnimeFileMask	ALL A mask with all fields set.
static AnimeFileMask	NONE A mask with no field set.

Constructor Summary

AnimeFileMask(boolean animeTotalEpisode, boolean highestEpisodeNumber, boolean year, boolean type, boolean relatedAidList, boolean relatedAidType, boolean categoryList, boolean romajiName, boolean kanjiName, boolean englishName, boolean otherNames, boolean shortNameList, boolean synonymList, boolean episodeNumber, boolean episodeName, boolean episodeRomajiName, boolean episodeKanjiName, boolean episodeRating, boolean episodeVoteCount, boolean groupName, boolean groupShortName, boolean dateAnimeIdRecordUpdate)
Creates an anime file 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	isAnimeTotalEpisode() Returns the total episodes of the anime.
boolean	isCategoryList() Returns the category list.
boolean	isDateAnimeIdRecordUpdate() Returns the date of the anime Id record update.
boolean	isEnglishName() Returns the english name.
boolean	isEpisodeKanjiName() Returns the episode kanji name.
boolean	isEpisodeName() Returns the episode name.
boolean	isEpisodeNumber() Returns the episode number.
boolean	isEpisodeRating() Returns the episode rating.
boolean	isEpisodeRomajiName() Returns the episode romaji name.
boolean	isEpisodeVoteCount() Returns the episode vote count.
boolean	isGroupName() Returns the group name.
boolean	isGroupShortName() Returns the group short name.
boolean	isHighestEpisodeNumber() Returns the highest episode number.
boolean	isKanjiName() Returns the kanji name.
boolean	isOtherNames() Returns the other names list.
boolean	isRelatedAidList() Returns the related anime Id list.
boolean	isRelatedAidType() Returns the related anime Id type.
boolean	isRomajiName() Returns the romaji name.
boolean	isShortNameList() Returns the short name list.
boolean	isSynonymList() Returns the synonym list.
boolean	isType() Returns the type.
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 AnimeFileMask ALL

A mask with all fields set.

NONE

public static final AnimeFileMask NONE

A mask with no field set.

Constructor Detail

AnimeFileMask

public AnimeFileMask(boolean animeTotalEpisode,
                     boolean highestEpisodeNumber,
                     boolean year,
                     boolean type,
                     boolean relatedAidList,
                     boolean relatedAidType,
                     boolean categoryList,
                     boolean romajiName,
                     boolean kanjiName,
                     boolean englishName,
                     boolean otherNames,
                     boolean shortNameList,
                     boolean synonymList,
                     boolean episodeNumber,
                     boolean episodeName,
                     boolean episodeRomajiName,
                     boolean episodeKanjiName,
                     boolean episodeRating,
                     boolean episodeVoteCount,
                     boolean groupName,
                     boolean groupShortName,
                     boolean dateAnimeIdRecordUpdate)

Creates an anime file mask.

Parameters:

animeTotalEpisode - The total episodes of the anime.

highestEpisodeNumber - The highest episode number.

year - The year.

type - The type.

relatedAidList - The related anime Id list.

relatedAidType - The related anime Id type.

categoryList - The category 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.

episodeNumber - The episode number.

episodeName - The episode name.

episodeRomajiName - The episode romaji name.

episodeKanjiName - The episode kanji name.

episodeRating - The episode rating.

episodeVoteCount - The episode vote count.

groupName - The group name.

groupShortName - The group short name.

dateAnimeIdRecordUpdate - The date of the anime Id record update.

Method Detail

isAnimeTotalEpisode

public boolean isAnimeTotalEpisode()

Returns the total episodes of the anime.

Returns:

The total episodes of the anime.

isHighestEpisodeNumber

public boolean isHighestEpisodeNumber()

Returns the highest episode number.

Returns:

The highest episode number.

isYear

public boolean isYear()

Returns the year.

Returns:

The year.

isType

public boolean isType()

Returns the type.

Returns:

The type.

isRelatedAidList

public boolean isRelatedAidList()

Returns the related anime Id list.

Returns:

The related anime Id list.

isRelatedAidType

public boolean isRelatedAidType()

Returns the related anime Id type.

Returns:

The related anime Id type.

isCategoryList

public boolean isCategoryList()

Returns the category list.

Returns:

The category 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.

isEpisodeNumber

public boolean isEpisodeNumber()

Returns the episode number.

Returns:

The episode number.

isEpisodeName

public boolean isEpisodeName()

Returns the episode name.

Returns:

The episode name.

isEpisodeRomajiName

public boolean isEpisodeRomajiName()

Returns the episode romaji name.

Returns:

The episode romaji name.

isEpisodeKanjiName

public boolean isEpisodeKanjiName()

Returns the episode kanji name.

Returns:

The episode kanji name.

isEpisodeRating

public boolean isEpisodeRating()

Returns the episode rating.

Returns:

The episode rating.

isEpisodeVoteCount

public boolean isEpisodeVoteCount()

Returns the episode vote count.

Returns:

The episode vote count.

isGroupName

public boolean isGroupName()

Returns the group name.

Returns:

The group name.

isGroupShortName

public boolean isGroupShortName()

Returns the group short name.

Returns:

The group short name.

isDateAnimeIdRecordUpdate

public boolean isDateAnimeIdRecordUpdate()

Returns the date of the anime Id record update.

Returns:

The date of the anime Id record update.

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