From 2c76c6165708b416f9a38b36c16a97f4a85e41fc Mon Sep 17 00:00:00 2001 From: Stephan Richter Date: Wed, 18 Dec 2024 22:58:21 +0100 Subject: [PATCH] preparing importer Signed-off-by: Stephan Richter --- .../de/srsoftware/cal/api/Appointment.java | 2 -- .../de/srsoftware/cal/api/Attachment.java | 1 - .../java/de/srsoftware/cal/api/Coords.java | 1 - .../java/de/srsoftware/cal/api/Importer.java | 21 +++++++++++++++++++ .../main/java/de/srsoftware/cal/api/Link.java | 3 +-- 5 files changed, 22 insertions(+), 6 deletions(-) create mode 100644 de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Importer.java diff --git a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Appointment.java b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Appointment.java index 028689e..0517ae8 100644 --- a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Appointment.java +++ b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Appointment.java @@ -9,7 +9,6 @@ import java.util.Set; * This is the central object of the calendar: An appointment */ public interface Appointment { - /** * list of attachments associated with the appointment. may be used for flyers or images * @return list of attachments @@ -66,5 +65,4 @@ public interface Appointment { * @return set of links */ Set urls(); - } diff --git a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Attachment.java b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Attachment.java index 045092b..c7c09af 100644 --- a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Attachment.java +++ b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Attachment.java @@ -7,7 +7,6 @@ import java.net.URL; * attachments may provide additional information about an appointment */ public interface Attachment { - /** * the mime type of the attached document * @return a mime type diff --git a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Coords.java b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Coords.java index 7055831..d1956aa 100644 --- a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Coords.java +++ b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Coords.java @@ -5,7 +5,6 @@ package de.srsoftware.cal.api; * cartesian coordinates */ public interface Coords { - /** * the longitude * @return the longitude diff --git a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Importer.java b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Importer.java new file mode 100644 index 0000000..24d97c8 --- /dev/null +++ b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Importer.java @@ -0,0 +1,21 @@ +/* © SRSoftware 2024 */ +package de.srsoftware.cal.api; + +import java.util.List; + +/** + * Instances of this class can be used to read Appointments from various sources + */ +public interface Importer { + /** + * Text descripbing this importer + * @return informational text + */ + String description(); + + /** + * get the list of appointments from the source associated with this importer + * @return a list of appointments + */ + List fetch(); +} diff --git a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Link.java b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Link.java index 89dc6d1..99260d2 100644 --- a/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Link.java +++ b/de.srsoftware.cal.api/src/main/java/de/srsoftware/cal/api/Link.java @@ -6,8 +6,7 @@ import java.net.URL; /** * Links are additional content that may be added to appointments */ -public interface Link{ - +public interface Link { /** * some information about the target of the link * @return descriptive text