You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 1, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: Documentation.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,27 @@
1
-
#Documentation
1
+
#Documentation
2
2
For version 1.1.0
3
3
+[Introduction]()
4
4
+ Connection
5
5
+ Going down the objects
6
6
7
7
8
8
9
-
##Introduction
9
+
##Introduction
10
10
So you want to use this wrapper? Well get ready, as it is as easy as 1 2 insert parameters.
11
11
To get started, understand that i have never written one of these before. So good luck.
12
12
Please also take note that this is a huge wrapper and i forget junk here and there. So enjoy errors every so often.
13
13
14
14
All returns from jikan are as CompletableFutures. So you can have async computing!
15
15
16
-
##How this wrapper works
16
+
##How this wrapper works
17
17
There is a single class that communicates to jikan and back, this class is the [Retriever](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/Retriever.java).
18
18
The class is the parent class of many objects within this wrapper, being the main driving force for parsing and communication.
19
19
You can use this class to bypass the convenient pre-built objects to parse data. But do so at your own risk, as you need to make all the URLs yourself.
20
20
21
21
The Retriever class parents two main classes, the [Connector](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/Connector.java) and
22
22
the [Search](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/search/Search.java) classes. These allow you to easily retrieve data from jikan with mostly no worries.
23
23
24
-
###Connector class
24
+
###Connector class
25
25
If you peak at the code of the class [Connector](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/Connector.java), you can see that this class takes care of most operations.
26
26
27
27
An example of usage is as following
@@ -41,7 +41,7 @@ public class Main{
41
41
```
42
42
The above prints out the results of seasonLater search, it can also be used to assign variables with option B;
43
43
44
-
###Search objects
44
+
###Search objects
45
45
If you look into the code of [Search](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/search/Search.java), you can see it is the parent object of multiple classes (go up the directory)
46
46
47
47
An example of usage would be the following
@@ -89,4 +89,4 @@ public class Main{
89
89
* Method A uses a child object to retrieve a more complex querying of Manga; there is also a similar class for Anime.
90
90
* Method B uses the search class with appropriate parameters (PersonPage, MangaPage,CharacterPage,AnimePage) and a secondary Type reinforcements (if they are mismatched an ERROR is 100% likely to occur). Method A first searches for someone with a limit of 2, then it gets the first one, then it retrieves someone by their ID.
91
91
92
-
These are the basic things you should know, ask questions on the main discord server to the dev (me) Clocks.
92
+
These are the basic things you should know, ask questions on the main discord server to the dev (me) Clocks.
0 commit comments