Package xyz.krmentos.adofaigg

Class AdofaiGG

java.lang.Object
xyz.krmentos.adofaigg.AdofaiGG
public class AdofaiGG extends Object
이 클래스는 Adofai.gg API의 메인 클래스입니다.

데이터는 설정된 LoadOption에 따라 불러오게 되며, 불러오는 시간은 초 단위로 설정됩니다.

기본 구성:

Adofai.gg API는 AdofaiGG 객체를 생성한 후 데이터를 불러올 수 있습니다.

맵 데이터는 MapQuery를 통해, 클리어 데이터는 ClearQuery를 통해, 유저 데이터는 UserQuery를 통해 필터를 설정할 수 있습니다.

데이터를 수동으로 받기 위해서는 LoadManager를 참조하세요.

See Also:

  • Constructor Details

    • AdofaiGG

      public AdofaiGG()
      기본 구성으로 AdofaiGG 개체를 구성합니다.

    • AdofaiGG

      public AdofaiGG(LoadOption loadOption)
      설정한 구성과 기본 구성으로 AdofaiGG 개체를 구성합니다.
      Parameters:
      loadOption - 데이터를 받아오는 조건을 설정합니다.
      See Also:

    • AdofaiGG

      public AdofaiGG(LoadOption loadOption, long time)
      설정한 구성으로 AdofaiGG 개체를 구성합니다.
      Parameters:
      loadOption - 데이터를 받아오는 조건을 설정합니다.
      time - 데이터를 받아오는 시간을 초 단위로 설정합니다.
      See Also:

    • AdofaiGG

      public AdofaiGG(LoadOption loadOption, int minute, int second)
      설정한 구성으로 AdofaiGG 개체를 구성합니다.
      Parameters:
      loadOption - 데이터를 받아오는 조건을 설정합니다.
      minute - 데이터를 받아오는 시간을 분 단위로 설정합니다.
      second - 데이터를 받아오는 시간을 초 단위로 설정합니다.
      See Also:

    • AdofaiGG

      public AdofaiGG(LoadOption loadOption, int hour, int minute, int second)
      설정한 구성으로 AdofaiGG 개체를 구성합니다.
      Parameters:
      loadOption - 데이터를 받아오는 조건을 설정합니다.
      hour - 데이터를 받아오는 시간을 시간 단위로 설정합니다.
      minute - 데이터를 받아오는 시간을 분 단위로 설정합니다.
      second - 데이터를 받아오는 시간을 초 단위로 설정합니다.
      See Also:

    • AdofaiGG

      public AdofaiGG(LoadOption loadOption, int day, int hour, int minute, int second)
      설정한 구성으로 AdofaiGG 개체를 구성합니다.
      Parameters:
      loadOption - 데이터를 받아오는 조건을 설정합니다.
      day - 데이터를 받아오는 시간을 일 단위로 설정합니다.
      hour - 데이터를 받아오는 시간을 시간 단위로 설정합니다.
      minute - 데이터를 받아오는 시간을 분 단위로 설정합니다.
      second - 데이터를 받아오는 시간을 초 단위로 설정합니다.
      See Also:

  • Method Details

    • getMapById

      public MapData getMapById(int id)
      Id를 통해 MapData를 불러옵니다.

      예시 사용법:

      MapData map = getMapById(123);

      Parameters:
      id - 검색할 MapData의 식별자입니다.
      Returns:
      지정된 id와 관련된 MapData 객체입니다.
      Throws:
      ArrayIndexOutOfBoundsException - 제공된 id가 현재 맵 배열의 범위를 벗어난 경우 예외가 발생합니다.
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getMapByName

      public List<MapData> getMapByName(String query)
      지정된 문자열을 포함하는 노래 제목을 가진 모든 MapData를 반환합니다.
      Parameters:
      query - 검색할 문자열입니다.
      Returns:
      검색 조건을 만족하는 MapData 객체들의 목록입니다.
      Throws:
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getMapByQuery

      public List<MapData> getMapByQuery(MapQuery query)
      지정된 MapQuery에 따라 필터링된 MapData의 목록을 반환합니다.
      Parameters:
      query - MapQuery 객체로 지정된 검색 조건입니다.
      Returns:
      검색 조건을 만족하는 MapData 객체들의 목록입니다.
      Throws:
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getMaps

      public MapData[] getMaps()
      현재 로드된 모든 MapData 배열을 반환합니다.
      Returns:
      현재 로드된 모든 MapData 객체들의 배열입니다.
      Throws:
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getClearById

      public ClearData getClearById(int id)
      지정된 Id에 해당하는 ClearData를 반환합니다.
      Parameters:
      id - 검색할 ClearData의 식별자입니다.
      Returns:
      지정된 id와 관련된 ClearData 객체입니다.
      Throws:
      ArrayIndexOutOfBoundsException - 제공된 id가 현재 ClearData 배열의 범위를 벗어난 경우 예외가 발생합니다.
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getClearByQuery

      public List<ClearData> getClearByQuery(ClearQuery query)
      지정된 ClearQuery에 따라 필터링된 ClearData 목록을 반환합니다.
      Parameters:
      query - ClearQuery 객체로 지정된 검색 조건입니다.
      Returns:
      검색 조건을 만족하는 ClearData 객체들의 목록입니다.
      Throws:
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getClears

      public ClearData[] getClears()
      현재 로드된 모든 ClearData 배열을 반환합니다.
      Returns:
      현재 로드된 모든 ClearData 객체들의 배열입니다.
      Throws:
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getUserById

      public UserData getUserById(int id)
      지정된 Id에 해당하는 UserData를 반환합니다.
      Parameters:
      id - 검색할 UserData의 식별자입니다.
      Returns:
      지정된 id와 관련된 UserData 객체입니다.
      Throws:
      ArrayIndexOutOfBoundsException - 제공된 id가 현재 UserData 배열의 범위를 벗어난 경우 예외가 발생합니다.
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getUserByQuery

      public List<UserData> getUserByQuery(UserQuery query)
      지정된 UserQuery에 따라 필터링된 UserData 목록을 반환합니다.
      Parameters:
      query - UserQuery 객체로 지정된 검색 조건입니다.
      Returns:
      검색 조건을 만족하는 UserData 객체들의 목록입니다.
      Throws:
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.

    • getUsers

      public UserData[] getUsers()
      현재 로드된 모든 UserData 배열을 반환합니다.
      Returns:
      현재 로드된 모든 UserData 객체들의 배열입니다.
      Throws:
      DataNotLoaded - 데이터가 로딩되지 않았을 경우 예외가 발생합니다.