Skip to content

Commit

Permalink
create docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dyzio18 committed May 20, 2018
1 parent e68c5ee commit 567135e
Show file tree
Hide file tree
Showing 28 changed files with 40 additions and 0 deletions.
25 changes: 25 additions & 0 deletions src/main/java/stdBot/AddressUtility.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@

public class AddressUtility {

/**
* This method check and return true if address is correct HTTP URL
* in other cases return false
*
* @param String address
* @return boolean
*/
static public boolean isHttp(String address){
try {
new URI(address);
Expand All @@ -14,10 +21,22 @@ static public boolean isHttp(String address){
}
}

/**
* This method check internal references for address
*
* @param String address
* @return boolean
*/
static public boolean isInternalRef(String address){
return !address.contains(".");
}

/**
* This method can replace adresses startet to www. on domain address URL
*
* @param String address
* @return String
*/
static public String clearHttpAddress(String address){
try {
URI uri = new URI(address);
Expand All @@ -28,6 +47,12 @@ static public String clearHttpAddress(String address){
}
}

/**
* This method return correct Uniform Resource Identifier (URI) address or null as exception
*
* @param String address
* @return String
*/
static public String getScheme(String address){
try {
URI uri = new URI(address);
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/stdBot/CollectorTypeEnum.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
package stdBot;

/**
* This enum allows to switch adequate type to fabric.
* Then fabric generate that type.
*/
public enum CollectorTypeEnum {
HyperLinks,
Map
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/stdBot/HttpRemoteHandler.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
import java.net.URL;
import java.net.URLConnection;

/**
* This class allows to connect with remote server
*/
public class HttpRemoteHandler implements RemoteHandler {

private String address = "";
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/stdBot/HyperLinksCollector.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
package stdBot;

/**
* This class call fabric for create hyperlinks
*/
public class HyperLinksCollector extends RemoteCollector {

public HyperLinksCollector(RemoteHandler handler, String address, int maxRecursionLevel) {
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/stdBot/MapCollector.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
package stdBot;

/**
* This class call fabric for create maps
*/
public class MapCollector extends RemoteCollector {

public MapCollector(RemoteHandler handler, String address, int maxRecurtionLevel) {
super(handler, address, maxRecurtionLevel);
collectableRemotely = factory.create(MapTypeEnum.SiteMap);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/stdBot/MapsFactory.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package stdBot;


public class MapsFactory {

public CollectableRemotely create(MapTypeEnum mapTypeEnum){
Expand Down
Binary file removed target/classes/Demo.class
Binary file not shown.
Binary file removed target/classes/demo/Common.class
Binary file not shown.
Binary file removed target/classes/stdBot/AddressUtility.class
Binary file not shown.
Binary file removed target/classes/stdBot/App.class
Binary file not shown.
Binary file removed target/classes/stdBot/CollectableRemotely.class
Binary file not shown.
Binary file removed target/classes/stdBot/CollectorTypeEnum.class
Binary file not shown.
Binary file removed target/classes/stdBot/CollectorsFactory$1.class
Binary file not shown.
Binary file removed target/classes/stdBot/CollectorsFactory.class
Binary file not shown.
Binary file removed target/classes/stdBot/HttpRemoteHandler.class
Binary file not shown.
Binary file removed target/classes/stdBot/HyperLinksCollector.class
Binary file not shown.
Binary file removed target/classes/stdBot/MapCollector.class
Binary file not shown.
Binary file removed target/classes/stdBot/MapTypeEnum.class
Binary file not shown.
Binary file removed target/classes/stdBot/MapsFactory$1.class
Binary file not shown.
Binary file removed target/classes/stdBot/MapsFactory.class
Binary file not shown.
Binary file removed target/classes/stdBot/RemoteCollector.class
Binary file not shown.
Binary file removed target/classes/stdBot/RemoteHandler.class
Binary file not shown.
Binary file removed target/classes/stdBot/RemoteHandlersFactory.class
Binary file not shown.
Binary file removed target/classes/stdBot/RemoteHyperLinksMap.class
Binary file not shown.
Binary file removed target/classes/stdBot/RemoteMapper.class
Binary file not shown.
Binary file removed target/classes/stdBot/RemoteSiteMap.class
Binary file not shown.
Binary file removed target/classes/stdBot/SiteMap.class
Binary file not shown.
Binary file removed target/test-classes/stdBot/AppTest.class
Binary file not shown.

0 comments on commit 567135e

Please sign in to comment.