Skip to content

Commit 486b3f8

Browse files
authored
Update README.md
1 parent 8243681 commit 486b3f8

File tree

1 file changed

+66
-2
lines changed

1 file changed

+66
-2
lines changed

Classes de Ajuda/README.md

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Classes de Ajuda
22
## Pequenas classes em Java que poderão ajudar no dia-a-dia!
33

4-
### GetJSON.java
4+
## GetJSON.java
55
#### Descrição:
66

77
##### Esta pequena classe possui a função de resgatar os arquivos .json de uma API pública qualquer, fornecida pelo usuário através de uma URL em formato String.
@@ -16,7 +16,7 @@ GetJSON g = new GetJSON("https://example.com/json");
1616
JSONObject j = g.get();
1717
```
1818

19-
### Contador.java
19+
## Contador.java
2020
#### Descrição:
2121

2222
##### Esta pequena classe possui a função de criar um pequeno relógio que poderá ser utilizado como um contador de tempo de execução do programa ou de outras funções essenciais do programa, como o tempo de execução de um método ou loop ou o tempo entre um método e outro.
@@ -87,3 +87,67 @@ while(c.isRunning()) {
8787
}
8888
System.out.println("");
8989
```
90+
91+
## Logg.java
92+
#### Descrição:
93+
94+
##### Esta pequena classe possui a função de criar um arquivo de registro (log) e registrar diversas ocorrências durante a execução do programa ao chamar os métodos de escrita disponíveis.
95+
96+
##### É possível iniciar um objeto Logg de duas maneiras: Com nome de arquivo customizado ou com nome de arquivo padrão (MyLogg.txt).
97+
98+
##### Ao iniciar o objeto com nome de arquivo, é possível inserir como forma de caminho onde o arquivo de registro estará localizado. Mas certifique-se de ser um local existente e que o programa tenha permissão de escrita naquele local, caso contrário as mensagens não poderão ser escritas e você receberá uma mensagem de erro!
99+
100+
##### Caso inicie o objeto utilizando o nome padrão, será criado um arquivo (MyLogg.txt) na mesma pasta que o programa está sendo executado.
101+
102+
##### Veja os exemplos abaixo:
103+
```Java
104+
// Criando um registro com nome padrão
105+
Logg l = new Logg();
106+
l.writeLogg("Olá, mundo!");
107+
108+
// Criando um registro com nome customizado
109+
Logg o = new Logg("CustomLogg.txt");
110+
o.writeLogg("Olá, mundo!");
111+
112+
// Criando um registro com nome e caminho customizado
113+
Logg g = new Logg("/home/user/CustomLogg.txt");
114+
g.writeLogg("Olá, mundo!");
115+
```
116+
117+
##### A classe possui duas maneiras de você inserir uma mensagem no arquivo de registro: Sem data e hora ou com data e hora inseridos.
118+
```Java
119+
// Escrevendo no arquivo de log sem data e hora
120+
public void writeLogg([String message]);
121+
122+
// Escrevendo no arquivo de log com data e hora
123+
public void writeDatedLogg([String message]);
124+
```
125+
126+
##### É possível também alterar a formatação da data e hora que serão inseridas ao invocar o método writeDatedLogg:
127+
```Java
128+
// Configurando o formato de data (padrão: HH:mm:ss | dd/MM/yyyy)
129+
public void setDateFormat(String dateFormat);
130+
```
131+
132+
##### Os padrões de data e hora permitidos são os mesmos da classe [SimpleDateFormat](https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html) e estão disponíveis na documentação oficial da classe.
133+
134+
#### Requerimentos:
135+
- Java 8
136+
137+
#### Exemplos de uso:
138+
```Java
139+
Logg l = new Logg("MeuLogg.txt");
140+
141+
l.writeLogg("Esta é uma mensagem sem data e hora!");
142+
l.writeDatedLogg("Esta é uma mensagem com data e hora!");
143+
144+
l.setDateFormat("yyyy/MM/dd - HH:mm:ss");
145+
l.writeDatedLogg("Esta é uma mensagem com data e hora formatadas!")
146+
```
147+
148+
##### O arquivo de registro MeuLogg.txt, portanto, deverá estar da seguinte maneira:
149+
```Text
150+
Esta é uma mensagem sem data e hora!
151+
[15:03:25 | 16/08/2017] Está é uma mensagem com data e hora!
152+
[2017/08/16 - 15:03:25] Está é uma mensagem com data e hora formatadas!
153+
```

0 commit comments

Comments
 (0)