Merge pull request #27 from ical4j/develop

Added property accessors/modifiers

Author: benfortuna

.github/workflows/create-release.yml

@@ -0,0 +1,21 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - "ical4j-vcard-*"
+      - "!ical4j-vcard-*-pre"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      #      - name: Generate changelog
+      #        run: make changelog
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+#          body_path: CHANGELOG.md

gradle.properties

@@ -1,4 +1,4 @@
-ical4jVersion=4.0.0-rc6
+ical4jVersion=4.0.2
 
 log4jVersion=2.22.1
 commonsIoVersion=2.15.1

src/main/java/net/fortuna/ical4j/vcard/AddressPropertyAccessor.java

@@ -0,0 +1,13 @@
+package net.fortuna.ical4j.vcard;
+
+import net.fortuna.ical4j.model.PropertyContainer;
+import net.fortuna.ical4j.vcard.property.Address;
+
+import java.util.List;
+
+public interface AddressPropertyAccessor extends PropertyContainer {
+
+    default List<Address> getAddresses() {
+        return getProperties(PropertyName.ADR.toString());
+    }
+}

src/main/java/net/fortuna/ical4j/vcard/AddressPropertyModifiers.java

@@ -0,0 +1,51 @@
+/*
+ *  Copyright (c) 2024, Ben Fortuna
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *
+ *   o Redistributions of source code must retain the above copyright
+ *  notice, this list of conditions and the following disclaimer.
+ *
+ *   o Redistributions in binary form must reproduce the above copyright
+ *  notice, this list of conditions and the following disclaimer in the
+ *  documentation and/or other materials provided with the distribution.
+ *
+ *   o Neither the name of Ben Fortuna nor the names of any other contributors
+ *  may be used to endorse or promote products derived from this software
+ *  without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+package net.fortuna.ical4j.vcard;
+
+import net.fortuna.ical4j.model.PropertyContainer;
+import net.fortuna.ical4j.vcard.property.Address;
+
+import java.util.function.BiFunction;
+
+/**
+ * A collection of functions used to modify properties in a target property container.
+ * Used in conjunction with {@link PropertyContainer#with(BiFunction, Object)}
+ */
+public interface AddressPropertyModifiers {
+
+    BiFunction<PropertyContainer, Address, PropertyContainer> ADR = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+}

src/main/java/net/fortuna/ical4j/vcard/CalendarPropertyAccessor.java

@@ -0,0 +1,23 @@
+package net.fortuna.ical4j.vcard;
+
+import net.fortuna.ical4j.model.PropertyContainer;
+import net.fortuna.ical4j.vcard.property.CalAdrUri;
+import net.fortuna.ical4j.vcard.property.CalUri;
+import net.fortuna.ical4j.vcard.property.FbUrl;
+
+import java.util.List;
+
+public interface CalendarPropertyAccessor extends PropertyContainer {
+
+    default List<FbUrl> getFbUrls() {
+        return getProperties(PropertyName.FBURL.toString());
+    }
+
+    default List<CalAdrUri> getCalAdrUris() {
+        return getProperties(PropertyName.CALADRURI.toString());
+    }
+
+    default List<CalUri> getCalUris() {
+        return getProperties(PropertyName.CALURI.toString());
+    }
+}

src/main/java/net/fortuna/ical4j/vcard/CalendarPropertyModifiers.java

@@ -0,0 +1,63 @@
+/*
+ *  Copyright (c) 2024, Ben Fortuna
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *
+ *   o Redistributions of source code must retain the above copyright
+ *  notice, this list of conditions and the following disclaimer.
+ *
+ *   o Redistributions in binary form must reproduce the above copyright
+ *  notice, this list of conditions and the following disclaimer in the
+ *  documentation and/or other materials provided with the distribution.
+ *
+ *   o Neither the name of Ben Fortuna nor the names of any other contributors
+ *  may be used to endorse or promote products derived from this software
+ *  without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+package net.fortuna.ical4j.vcard;
+
+import net.fortuna.ical4j.model.PropertyContainer;
+import net.fortuna.ical4j.vcard.property.CalAdrUri;
+import net.fortuna.ical4j.vcard.property.CalUri;
+import net.fortuna.ical4j.vcard.property.FbUrl;
+
+import java.util.function.BiFunction;
+
+/**
+ * A collection of functions used to modify properties in a target property container.
+ * Used in conjunction with {@link PropertyContainer#with(BiFunction, Object)}
+ */
+public interface CalendarPropertyModifiers {
+
+    BiFunction<PropertyContainer, FbUrl, PropertyContainer> FBURL = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+
+    BiFunction<PropertyContainer, CalAdrUri, PropertyContainer> CALADRURI = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+
+    BiFunction<PropertyContainer, CalUri, PropertyContainer> CALURI = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+}

src/main/java/net/fortuna/ical4j/vcard/CommunicationsPropertyAccessor.java

@@ -0,0 +1,28 @@
+package net.fortuna.ical4j.vcard;
+
+import net.fortuna.ical4j.model.PropertyContainer;
+import net.fortuna.ical4j.vcard.property.Email;
+import net.fortuna.ical4j.vcard.property.Impp;
+import net.fortuna.ical4j.vcard.property.Lang;
+import net.fortuna.ical4j.vcard.property.Telephone;
+
+import java.util.List;
+
+public interface CommunicationsPropertyAccessor extends PropertyContainer {
+
+    default List<Telephone> getTelephones() {
+        return getProperties(PropertyName.TEL.toString());
+    }
+
+    default List<Email> getEmails() {
+        return getProperties(PropertyName.EMAIL.toString());
+    }
+
+    default List<Impp> getImpps() {
+        return getProperties(PropertyName.IMPP.toString());
+    }
+
+    default List<Lang> getLangs() {
+        return getProperties(PropertyName.LANG.toString());
+    }
+}

src/main/java/net/fortuna/ical4j/vcard/CommunicationsPropertyModifiers.java

@@ -0,0 +1,69 @@
+/*
+ *  Copyright (c) 2024, Ben Fortuna
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *
+ *   o Redistributions of source code must retain the above copyright
+ *  notice, this list of conditions and the following disclaimer.
+ *
+ *   o Redistributions in binary form must reproduce the above copyright
+ *  notice, this list of conditions and the following disclaimer in the
+ *  documentation and/or other materials provided with the distribution.
+ *
+ *   o Neither the name of Ben Fortuna nor the names of any other contributors
+ *  may be used to endorse or promote products derived from this software
+ *  without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+package net.fortuna.ical4j.vcard;
+
+import net.fortuna.ical4j.model.PropertyContainer;
+import net.fortuna.ical4j.vcard.property.Email;
+import net.fortuna.ical4j.vcard.property.Impp;
+import net.fortuna.ical4j.vcard.property.Lang;
+import net.fortuna.ical4j.vcard.property.Telephone;
+
+import java.util.function.BiFunction;
+
+/**
+ * A collection of functions used to modify properties in a target property container.
+ * Used in conjunction with {@link PropertyContainer#with(BiFunction, Object)}
+ */
+public interface CommunicationsPropertyModifiers {
+
+    BiFunction<PropertyContainer, Telephone, PropertyContainer> TEL = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+
+    BiFunction<PropertyContainer, Email, PropertyContainer> EMAIL = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+
+    BiFunction<PropertyContainer, Impp, PropertyContainer> IMPP = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+
+    BiFunction<PropertyContainer, Lang, PropertyContainer> LANG = (c, p) -> {
+        if (p != null) c.add(p);
+        return c;
+    };
+}

src/main/java/net/fortuna/ical4j/vcard/ExplanatoryPropertyAccessor.java

@@ -0,0 +1,46 @@
+package net.fortuna.ical4j.vcard;
+
+import net.fortuna.ical4j.model.PropertyContainer;
+import net.fortuna.ical4j.vcard.property.*;
+
+import java.util.List;
+import java.util.Optional;
+
+public interface ExplanatoryPropertyAccessor extends PropertyContainer {
+
+    default List<Categories> getCategories() {
+        return getProperties(PropertyName.CATEGORIES.toString());
+    }
+
+    default List<Note> getNotes() {
+        return getProperties(PropertyName.NOTE.toString());
+    }
+
+    default Optional<ProdId> getProdId() {
+        return getProperty(PropertyName.PRODID);
+    }
+
+    default Optional<Revision> getRevision() {
+        return getProperty(PropertyName.REV);
+    }
+
+    default List<Sound> getSounds() {
+        return getProperties(PropertyName.SOUND.toString());
+    }
+
+    default Optional<Uid> getUid() {
+        return getProperty(PropertyName.UID);
+    }
+
+    default List<ClientPidMap> getClientPidMaps() {
+        return getProperties(PropertyName.CLIENTPIDMAP.toString());
+    }
+
+    default List<Url> getUrls() {
+        return getProperties(PropertyName.URL.toString());
+    }
+
+    default Version getVersion() {
+        return getRequiredProperty(PropertyName.VERSION);
+    }
+}