Commit dbcc8219 authored by Hugo Roenick's avatar Hugo Roenick
Browse files

Commit parcial do item [OPENBUS-1898]/[OPENBUS-1939}: (Java) Documentar API da...

Commit parcial do item [OPENBUS-1898]/[OPENBUS-1939}: (Java) Documentar API da biblioteca de acesso do OpenBus 2.0
 

git-svn-id: https://subversion.tecgraf.puc-rio.br/engdist/openbus/sdk/java/branches/v2_proto@131804 ae0415b3-e90b-0410-900d-d0be9363c56b
parent f3c6478c
Pipeline #489 skipped
......@@ -67,8 +67,9 @@ public interface Connection {
String busid();
/**
* Recupera as Informações do login dessa conexão ou 'null' se a conexão não
* está autenticada, ou seja, não tem um login válido no barramento.
* Recupera as Informações do login dessa conexão ou <code>null</code> se a
* conexão não está autenticada, ou seja, não tem um login válido no
* barramento.
*
* @return as informações do login.
*/
......@@ -196,8 +197,8 @@ public interface Connection {
* conexão. Um login pode se tornar inválido caso o administrador
* explicitamente o torne inválido ou caso a thread interna de renovação de
* login não seja capaz de renovar o lease do login a tempo. Caso esse
* atributo seja 'null', nenhum objeto de callback é chamado na ocorrência
* desse evento.
* atributo seja <code>null</code>, nenhum objeto de callback é chamado na
* ocorrência desse evento.
* <p>
* Durante a execução dessa callback um novo login pode ser restabelecido.
* Neste caso, a chamada do barramento que recebeu a notificação de login
......@@ -224,7 +225,7 @@ public interface Connection {
* contexto de execução de uma chamada remota oriunda do barramento dessa
* conexão, essa operação devolve um objeto que representa a cadeia de
* chamadas do barramento que esta chamada faz parte. Caso contrário, devolve
* 'null'.
* <code>null</code>.
*
* @return Cadeia da chamada em execução.
*/
......@@ -271,9 +272,10 @@ public interface Connection {
* corrente (e.g. definido pelo {@link Current}) nesta conexão. A cadeia de
* chamadas informada foi associada previamente pela operação
* {@link #joinChain(CallerChain) joinChain}. Caso o contexto corrente não
* tenha nenhuma cadeia associada, essa operação devolve 'null'.
* tenha nenhuma cadeia associada, essa operação devolve <code>null</code>.
*
* @return Cadeia de chamadas associada ao contexto corrente ou 'null'.
* @return Cadeia de chamadas associada ao contexto corrente ou
* <code>null</code> .
*/
CallerChain getJoinedChain();
......
......@@ -121,8 +121,8 @@ public interface ConnectionManager {
* <p>
* Define a conexão "Requester" a ser utilizada em todas as chamadas feitas no
* contexto atual, por exemplo, o contexto representado pelo {@link Current}
* atual. Quando 'conn' é 'null' o contexto passa a ficar sem nenhuma conexão
* associada.
* atual. Quando <code>conn</code> é <code>null</code> o contexto passa a
* ficar sem nenhuma conexão associada.
*
* @param conn Conexão a ser associada ao contexto corrente.
*/
......@@ -131,8 +131,8 @@ public interface ConnectionManager {
/**
* Devolve a conexão associada ao contexto corrente.
*
* @return Conexão associada ao contexto corrente, ou 'null' caso não haja
* nenhuma conexão associada.
* @return Conexão associada ao contexto corrente, ou <code>null</code> caso
* não haja nenhuma conexão associada.
*/
Connection getRequester();
......@@ -155,8 +155,9 @@ public interface ConnectionManager {
*
* @param busid Identificador do barramento ao qual a conexão está associada.
*
* @return Conexão "Dispatcher" do barramento indicado, ou 'null' caso não
* haja nenhuma conexão "Dispatcher" associada ao barramento indicado.
* @return Conexão "Dispatcher" do barramento indicado, ou <code>null</code>
* caso não haja nenhuma conexão "Dispatcher" associada ao barramento
* indicado.
*/
Connection getDispatcher(String busid);
......@@ -165,8 +166,8 @@ public interface ConnectionManager {
*
* @param busid Identificador do barramento ao qual a conexão está associada.
*
* @return Conexão "Dispatcher" associada ao barramento ou 'null' se não
* houver nenhuma conexão associada.
* @return Conexão "Dispatcher" associada ao barramento ou <code>null</code>
* se não houver nenhuma conexão associada.
*/
Connection clearDispatcher(String busid);
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment