Module Mal4J

Package dev.katsute.mal4j.query

Class FieldQuery<T extends FieldQuery<T,R>,R>

java.lang.Object

dev.katsute.mal4j.query.LimitOffsetQuery<T,R>

dev.katsute.mal4j.query.FieldQuery<T,R>

Type Parameters:

T - this

R - response

Direct Known Subclasses:

AnimeCharacterQuery, AnimeRankingQuery, AnimeSeasonQuery, AnimeSuggestionQuery, MangaRankingQuery, SearchQuery, UserAnimeListQuery, UserMangaListQuery

public abstract class FieldQuery<T extends FieldQuery<T,R>,R>
extends LimitOffsetQuery<T,R>

Represents a field query. Returns all fields by default.

Since:

1.0.0

Version:

2.2.0

Author:

Katsute

See Also:

• Fields.anime
• Fields.manga

Method Summary

Modifier and Type	Method	Description
final T	invertFields()	Makes the query return all except the fields provided.
final T	invertFields(boolean inverted)	Makes the query return all except the fields provided.
final T	withAllFields()	Makes query return all possible fields.
final T	withField(String field)	Adds a field to return.
final T	withFields(String... fields)	Adds a list of fields to return.
final T	withFields(List<String> fields)	Adds a list of fields to return.
final T	withNoFields()	Makes query return only default fields.

Methods inherited from class dev.katsute.mal4j.query.LimitOffsetQuery

search, searchAll, withLimit, withOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withField

public final T withField(String field)

Adds a field to return.

Parameters:

field - a field or comma separated fields that should be returned

Returns:

query

Since:

1.0.0

See Also:

• Fields.anime
• Fields.manga
• withFields(String...)
• withFields(List)
• withAllFields()
• invertFields()
• invertFields(boolean)
• withNoFields()

withFields

public final T withFields(String... fields)

Adds a list of fields to return.

Parameters:

fields - a comma separated string or a string array of the fields that should be returned

Returns:

query

Since:

1.0.0

See Also:

• Fields.anime
• Fields.manga
• withField(String)
• withFields(List)
• withAllFields()
• invertFields()
• invertFields(boolean)
• withNoFields()

withFields

public final T withFields(List<String> fields)

Adds a list of fields to return.

Parameters:

fields - a list of the fields that should be returned

Returns:

query

Since:

1.0.0

See Also:

• Fields.anime
• Fields.manga
• withField(String)
• withFields(String...)
• withAllFields()
• invertFields()
• invertFields(boolean)
• withNoFields()

withAllFields

public final T withAllFields()

Makes query return all possible fields.

Returns:

query

Since:

1.0.0

See Also:

• Fields.anime
• Fields.manga
• withField(String)
• withFields(String...)
• withFields(List)
• invertFields()
• invertFields(boolean)
• withNoFields()

invertFields

public final T invertFields()

Makes the query return all except the fields provided.

Returns:

query

Since:

2.2.0

See Also:

• withField(String)
• withFields(String...)
• withFields(List)
• withAllFields()
• invertFields(boolean)
• withNoFields()

invertFields

public final T invertFields(boolean inverted)

Makes the query return all except the fields provided.

Parameters:

inverted - whether the fields should be inverted or not

Returns:

query

Since:

2.2.0

See Also:

• withField(String)
• withFields(String...)
• withFields(List)
• withAllFields()
• invertFields()
• withNoFields()

withNoFields

public final T withNoFields()

Makes query return only default fields.

Returns:

query

Since:

1.0.0

See Also:

• Fields.NO_FIELDS
• withField(String)
• withFields(String...)
• withFields(List)
• withAllFields()
• invertFields()
• invertFields(boolean)