8000 Final documentation update · Dyzio18/java-web-bot-library@0079660 · GitHub
[go: up one dir, main page]

Skip to content 8000

Commit 0079660

Browse files
committed
Final documentation update
1 parent b668e10 commit 0079660

File tree

4 files changed

+28
-10
lines changed

4 files changed

+28
-10
lines changed

src/main/java/stdBot/AddressUtility.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public class AddressUtility {
99
* This method check and return true if address is correct HTTP URL
1010
* in other cases return false
1111
*
12-
* @param String address
12+
* @param address String
1313
* @return boolean
1414
*/
1515
static public boolean isHttp(String address) {
@@ -24,7 +24,7 @@ static public boolean isHttp(String address) {
2424
/**
2525
* This method check internal references for address
2626
*
27-
* @param String address
27+
* @param address String
2828
* @return boolean
2929
*/
3030
static public boolean isInternalRef(String address) {
@@ -34,7 +34,7 @@ static public boolean isInternalRef(String address) {
3434
/**
3535
* This method can replace addresses started to www. on domain address URL
3636
*
37-
* @param String address
37+
* @param address String
3838
* @return String
3939
*/
4040
static public String clearHttpAddress(String address) {

src/main/java/stdBot/App.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
package stdBot;
22

33

4-
public class App
5-
{
6-
public static void main( String[] args )
7-
{
4+
public class App {
5+
public static void main(String[] args) {
86
RemoteMapper remoteMapper = new RemoteMapper();
97

108
remoteMapper.start("http://www.wggios.agh.edu.pl/", CollectorTypeEnum.Map, 2);
119

1210
SiteMap siteMap = remoteMapper.getResult();
1311

14-
//siteMap.print();
15-
//siteMap.printInternalLinksNumber();
12+
siteMap.print();
13+
siteMap.printInternalLinksNumber();
1614
siteMap.printRelationsGraph();
1715
siteMap.printInternalLinksNumber();
1816
}

src/main/java/stdBot/RemoteHyperLinksMap.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,45 @@
44
* This class implements CollectableRemotely interface
55
*/
66
public class RemoteHyperLinksMap implements CollectableRemotely {
7+
/**
8+
*
9+
* @param address
10+
*/
711
@Override
812
public void setEntryPoint(String address) {
913

1014
}
1115

16+
/**
17+
*
18+
* @param handler This parameter is used to set adequate RemoteHandler
19+
*/
1220
@Override
1321
public void collectOne(RemoteHandler handler) {
1422
}
1523

24+
/**
25+
*
26+
* @return This returns null
27+
*/
1628
@Override
1729
public SiteMap getMap() {
1830
return null;
1931
}
2032

33+
/**
34+
*
35+
* @return This returns predefined boolean which is false
36+
*/
2137
@Override
2238
public boolean hasFinished() {
2339
return false;
2440
}
2541

42+
/**
43+
*
44+
* @param level This param sets the maximum depth of recursion search
45+
*/
2646
@Override
2747
public void setMaxRecursionLevel(int level) {
2848
}

src/main/java/stdBot/SiteMap.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ public void print() {
3737

3838
/**
3939
* @return String This returns is literally all data extracted from assigned starting url
40+
* in the form of the URL
4041
*/
4142
public String toHTML() {
4243
StringBuilder stringBuilder = new StringBuilder();
@@ -50,7 +51,6 @@ public String toHTML() {
5051
stringBuilder.append("<li><a href=\"" + relation.getKey() + "\">" + relation.getKey() + "</a> --> <a href=\"" + relation.getValue() + "\">" + relation.getValue() + "</a></li>");
5152

5253
return stringBuilder.toString();
53-
5454
}
5555

5656
/**

0 commit comments

Comments
 (0)
0