Skip to content

Commit

Permalink
Добавлено описание классов и методов
Browse files Browse the repository at this point in the history
  • Loading branch information
@kalenchukov
kalenchukov committed Mar 20, 2022
1 parent 2b87235 commit c877a33
Show file tree
Hide file tree
Showing 10 changed files with 207 additions and 91 deletions.
6 changes: 3 additions & 3 deletions README.MD
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ userAgentParser.setUserAgent(
"Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Firefox/91.0"
);

// Возвращает ID браузера
// Возвращает идентификатор браузера
userAgentParser.getBrowserId();
/*
Результат выполнения: 1
Expand All @@ -58,7 +58,7 @@ userAgentParser.getBrowserVersion();
Результат выполнения: 89.0.4389.105
*/

// Возвращает ID устройства
// Возвращает идентификатор устройства
userAgentParser.getDeviceId();
/*
Результат выполнения: 2
Expand All @@ -76,7 +76,7 @@ userAgentParser.getDeviceModel();
Результат выполнения: SM-A300FU
*/

// Возвращает ID операционной системы
// Возвращает идентификатор операционной системы
userAgentParser.getOperatingSystemId();
/*
Результат выполнения: 5
Expand Down
36 changes: 24 additions & 12 deletions src/main/java/dev/kalenchukov/useragentparser/Browser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ public final class Browser
Browser() {}

/**
* Возвращает название браузера по идентификатору
* Возвращает название браузера по идентификатору.
*
* @param id идентификатор браузера
* @return название браузера
* @param id Идентификатор браузера.
* @return Название браузера.
*/
@Nullable
public static String getById(@NotNull final Long id)
Expand All @@ -67,8 +67,7 @@ public static String getById(@NotNull final Long id)
{
if (browser.getId() != null)
{
if (browser != BrowserType.UNKNOWN && browser.getId().equals(id))
{
if (browser != BrowserType.UNKNOWN && browser.getId().equals(id)) {
return browser.getName();
}
}
Expand All @@ -78,10 +77,10 @@ public static String getById(@NotNull final Long id)
}

/**
* Возвращает идентификатор браузера по названию
* Возвращает идентификатор браузера по названию.
*
* @param name название браузера
* @return идентификатор браузера
* @param name Название браузера.
* @return Идентификатор браузера.
*/
@Nullable
public static Long getByName(@NotNull final String name)
Expand All @@ -102,9 +101,9 @@ public static Long getByName(@NotNull final String name)
}

/**
* Возвращает все типы браузеров
* Возвращает все типы браузеров.
*
* @return идентификатор и название браузера
* @return Коллекцию с идентификатором и названием браузера.
*/
@NotNull
public static Map<@NotNull Long, @NotNull String> getAll()
Expand All @@ -124,7 +123,7 @@ public static Long getByName(@NotNull final String name)
/**
* Устанавливает строку user-agent.
*
* @param userAgent строка user-agent
* @param userAgent Строка user-agent.
*/
void setUserAgent(@NotNull final String userAgent)
{
Expand All @@ -139,26 +138,37 @@ void setUserAgent(@NotNull final String userAgent)
}
}

/**
* @see BrowserType#getId()
*/
@Nullable
Long getId()
{
return this.browser.getId();
}

/**
* @see BrowserType#getName()
*/
@Nullable
String getName()
{
return this.browser.getName();
}

/**
* Возвращает версию браузера.
*
* @return Версия браузера.
*/
@Nullable
String getVersion()
{
return this.version;
}

/**
* Выполняет поиск шаблона регулярного выражения в строке user-agent.
* Выполняет поиск шаблона регулярного выражения в строке user-agent, и присваивает значения полям класса.
*/
private void execute()
{
Expand Down Expand Up @@ -187,6 +197,8 @@ private void execute()

/**
* Возвращает список регулярных выражений для определения браузера.
*
* @return Коллекцию строк регулярных выражений для браузеров.
*/
@NotNull
private Map<@NotNull String, @NotNull BrowserType> getRegExpBrowsers()
Expand Down
42 changes: 26 additions & 16 deletions src/main/java/dev/kalenchukov/useragentparser/Device.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ public final class Device
Device() {}

/**
* Возвращает тип устройства по идентификатору
* Возвращает тип устройства по идентификатору.
*
* @param id идентификатор устройства
* @return тип устройства
* @param id Идентификатор устройства.
* @return Тип устройства.
*/
@Nullable
public static String getById(@NotNull final Long id)
Expand All @@ -67,8 +67,7 @@ public static String getById(@NotNull final Long id)
{
if (device.getId() != null)
{
if (device != DeviceType.UNKNOWN && device.getId().equals(id))
{
if (device != DeviceType.UNKNOWN && device.getId().equals(id)) {
return device.getType();
}
}
Expand All @@ -78,10 +77,10 @@ public static String getById(@NotNull final Long id)
}

/**
* Возвращает идентификатор устройства по типу
* Возвращает идентификатор устройства по типу.
*
* @param type тип устройства
* @return идентификатор устройства
* @param type Тип устройства.
* @return Идентификатор устройства.
*/
@Nullable
public static Long getByType(@NotNull final String type)
Expand All @@ -92,8 +91,7 @@ public static Long getByType(@NotNull final String type)
{
if (device.getType() != null)
{
if (device != DeviceType.UNKNOWN && device.getType().equals(type))
{
if (device != DeviceType.UNKNOWN && device.getType().equals(type)) {
return device.getId();
}
}
Expand All @@ -103,9 +101,9 @@ public static Long getByType(@NotNull final String type)
}

/**
* Возвращает все типы устройств
* Возвращает все типы устройств.
*
* @return идентификатор и тип устройства
* @return Коллекцию с идентификатором и типом устройства.
*/
@NotNull
public static Map<@NotNull Long, @NotNull String> getAll()
Expand All @@ -114,8 +112,7 @@ public static Long getByType(@NotNull final String type)

for (DeviceType device : DeviceType.values())
{
if (device != DeviceType.UNKNOWN)
{
if (device != DeviceType.UNKNOWN) {
typesDevices.put(device.getId(), device.getType());
}
}
Expand All @@ -126,7 +123,7 @@ public static Long getByType(@NotNull final String type)
/**
* Устанавливает строку user-agent.
*
* @param userAgent строка user-agent
* @param userAgent Строка user-agent.
*/
void setUserAgent(@NotNull final String userAgent)
{
Expand All @@ -141,26 +138,37 @@ void setUserAgent(@NotNull final String userAgent)
}
}

/**
* @see DeviceType#getId()
*/
@Nullable
Long getId()
{
return this.device.getId();
}

/**
* @see DeviceType#getType()
*/
@Nullable
String getType()
{
return this.device.getType();
}

/**
* Возвращает модель устройства.
*
* @return Модель устройства.
*/
@Nullable
String getModel()
{
return this.model;
}

/**
* Выполняет поиск шаблона регулярного выражения в строке user-agent.
* Выполняет поиск шаблона регулярного выражения в строке user-agent, и присваивает значения полям класса.
*/
private void execute()
{
Expand Down Expand Up @@ -189,6 +197,8 @@ private void execute()

/**
* Возвращает список шаблонов регулярных выражений для определения устройства.
*
* @return Коллекцию строк регулярных выражений для устройств.
*/
@NotNull
private Map<@NotNull String, @NotNull DeviceType> getRegExpDevices()
Expand Down
Loading

0 comments on commit c877a33

Please sign in to comment.