#107 Improve JavaDoc for Observer example

This commit is contained in:
Ilkka Seppala 2015-08-21 22:28:51 +03:00
parent 86c68f96e3
commit 520f81d62e
11 changed files with 208 additions and 156 deletions

View File

@ -12,6 +12,10 @@ import com.iluwatar.observer.generic.GWeather;
*/
public class App {
/**
* Program entry point
* @param args command line args
*/
public static void main(String[] args) {
Weather weather = new Weather();
@ -33,6 +37,5 @@ public class App {
gWeather.timePasses();
gWeather.timePasses();
gWeather.timePasses();
}
}

View File

@ -1,5 +1,10 @@
package com.iluwatar.observer;
/**
*
* Hobbits
*
*/
public class Hobbits implements WeatherObserver {
@Override

View File

@ -1,5 +1,10 @@
package com.iluwatar.observer;
/**
*
* Orcs
*
*/
public class Orcs implements WeatherObserver {
@Override

View File

@ -5,7 +5,7 @@ import java.util.List;
/**
*
* Weather can be observed by implementing WeatherObserver interface and
* Weather can be observed by implementing {@link WeatherObserver} interface and
* registering as listener.
*
*/

View File

@ -1,5 +1,10 @@
package com.iluwatar.observer;
/**
*
* WeatherType enumeration
*
*/
public enum WeatherType {
SUNNY, RAINY, WINDY, COLD;

View File

@ -2,6 +2,11 @@ package com.iluwatar.observer.generic;
import com.iluwatar.observer.WeatherType;
/**
*
* GHobbits
*
*/
public class GHobbits implements Race {
@Override
public void update(GWeather weather, WeatherType weatherType) {

View File

@ -2,7 +2,13 @@ package com.iluwatar.observer.generic;
import com.iluwatar.observer.WeatherType;
/**
*
* GOrcs
*
*/
public class GOrcs implements Race {
@Override
public void update(GWeather weather, WeatherType weatherType) {
switch (weatherType) {

View File

@ -2,6 +2,11 @@ package com.iluwatar.observer.generic;
import com.iluwatar.observer.WeatherType;
/**
*
* GWeather
*
*/
public class GWeather extends Observable<GWeather, Race, WeatherType> {
private WeatherType currentWeather;

View File

@ -1,5 +1,13 @@
package com.iluwatar.observer.generic;
/**
*
* Observer
*
* @param <S>
* @param <O>
* @param <A>
*/
public interface Observer<S extends Observable<S, O, A>, O extends Observer<S, O, A>, A> {
void update(S subject, A argument);

View File

@ -2,5 +2,10 @@ package com.iluwatar.observer.generic;
import com.iluwatar.observer.WeatherType;
/**
*
* Race
*
*/
public interface Race extends Observer<GWeather, Race, WeatherType> {
}

View File

@ -4,6 +4,11 @@ import org.junit.Test;
import com.iluwatar.observer.App;
/**
*
* Application test
*
*/
public class AppTest {
@Test