#107 Improve JavaDoc for Observer example
This commit is contained in:
parent
86c68f96e3
commit
520f81d62e
observer/src
main/java/com/iluwatar/observer
test/java/com/iluwatar/observer
@ -12,6 +12,10 @@ import com.iluwatar.observer.generic.GWeather;
|
|||||||
*/
|
*/
|
||||||
public class App {
|
public class App {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Program entry point
|
||||||
|
* @param args command line args
|
||||||
|
*/
|
||||||
public static void main(String[] args) {
|
public static void main(String[] args) {
|
||||||
|
|
||||||
Weather weather = new Weather();
|
Weather weather = new Weather();
|
||||||
@ -33,6 +37,5 @@ public class App {
|
|||||||
gWeather.timePasses();
|
gWeather.timePasses();
|
||||||
gWeather.timePasses();
|
gWeather.timePasses();
|
||||||
gWeather.timePasses();
|
gWeather.timePasses();
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,10 @@
|
|||||||
package com.iluwatar.observer;
|
package com.iluwatar.observer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Hobbits
|
||||||
|
*
|
||||||
|
*/
|
||||||
public class Hobbits implements WeatherObserver {
|
public class Hobbits implements WeatherObserver {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -1,5 +1,10 @@
|
|||||||
package com.iluwatar.observer;
|
package com.iluwatar.observer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Orcs
|
||||||
|
*
|
||||||
|
*/
|
||||||
public class Orcs implements WeatherObserver {
|
public class Orcs implements WeatherObserver {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -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.
|
* registering as listener.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -1,5 +1,10 @@
|
|||||||
package com.iluwatar.observer;
|
package com.iluwatar.observer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* WeatherType enumeration
|
||||||
|
*
|
||||||
|
*/
|
||||||
public enum WeatherType {
|
public enum WeatherType {
|
||||||
|
|
||||||
SUNNY, RAINY, WINDY, COLD;
|
SUNNY, RAINY, WINDY, COLD;
|
||||||
|
@ -2,6 +2,11 @@ package com.iluwatar.observer.generic;
|
|||||||
|
|
||||||
import com.iluwatar.observer.WeatherType;
|
import com.iluwatar.observer.WeatherType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* GHobbits
|
||||||
|
*
|
||||||
|
*/
|
||||||
public class GHobbits implements Race {
|
public class GHobbits implements Race {
|
||||||
@Override
|
@Override
|
||||||
public void update(GWeather weather, WeatherType weatherType) {
|
public void update(GWeather weather, WeatherType weatherType) {
|
||||||
|
@ -2,7 +2,13 @@ package com.iluwatar.observer.generic;
|
|||||||
|
|
||||||
import com.iluwatar.observer.WeatherType;
|
import com.iluwatar.observer.WeatherType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* GOrcs
|
||||||
|
*
|
||||||
|
*/
|
||||||
public class GOrcs implements Race {
|
public class GOrcs implements Race {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void update(GWeather weather, WeatherType weatherType) {
|
public void update(GWeather weather, WeatherType weatherType) {
|
||||||
switch (weatherType) {
|
switch (weatherType) {
|
||||||
|
@ -2,6 +2,11 @@ package com.iluwatar.observer.generic;
|
|||||||
|
|
||||||
import com.iluwatar.observer.WeatherType;
|
import com.iluwatar.observer.WeatherType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* GWeather
|
||||||
|
*
|
||||||
|
*/
|
||||||
public class GWeather extends Observable<GWeather, Race, WeatherType> {
|
public class GWeather extends Observable<GWeather, Race, WeatherType> {
|
||||||
|
|
||||||
private WeatherType currentWeather;
|
private WeatherType currentWeather;
|
||||||
|
@ -1,5 +1,13 @@
|
|||||||
package com.iluwatar.observer.generic;
|
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> {
|
public interface Observer<S extends Observable<S, O, A>, O extends Observer<S, O, A>, A> {
|
||||||
|
|
||||||
void update(S subject, A argument);
|
void update(S subject, A argument);
|
||||||
|
@ -2,5 +2,10 @@ package com.iluwatar.observer.generic;
|
|||||||
|
|
||||||
import com.iluwatar.observer.WeatherType;
|
import com.iluwatar.observer.WeatherType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Race
|
||||||
|
*
|
||||||
|
*/
|
||||||
public interface Race extends Observer<GWeather, Race, WeatherType> {
|
public interface Race extends Observer<GWeather, Race, WeatherType> {
|
||||||
}
|
}
|
||||||
|
@ -4,6 +4,11 @@ import org.junit.Test;
|
|||||||
|
|
||||||
import com.iluwatar.observer.App;
|
import com.iluwatar.observer.App;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Application test
|
||||||
|
*
|
||||||
|
*/
|
||||||
public class AppTest {
|
public class AppTest {
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
Loading…
x
Reference in New Issue
Block a user