From 69895328be4a4ceaa44bccaf99cad7499c429928 Mon Sep 17 00:00:00 2001 From: UniquePassive Date: Thu, 19 Oct 2017 19:28:46 +0200 Subject: [PATCH 1/3] Add method mixin copy and replace functionality --- .../java/net/runelite/api/mixins/Copy.java | 42 +++++++++++++++++++ .../java/net/runelite/api/mixins/Replace.java | 42 +++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java create mode 100644 runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java diff --git a/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java b/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java new file mode 100644 index 0000000000..7f5ee9cc22 --- /dev/null +++ b/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2017, Adam + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. 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. + * + * 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.runelite.api.mixins; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +public @interface Copy +{ + /** + * Method to copy + * + * @return + */ + String value(); +} diff --git a/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java b/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java new file mode 100644 index 0000000000..f24d5db0f3 --- /dev/null +++ b/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2017, Adam + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. 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. + * + * 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.runelite.api.mixins; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +public @interface Replace +{ + /** + * Method to replace + * + * @return + */ + String value(); +} From 71382a7819682805e37123842fcf21fc8248061a Mon Sep 17 00:00:00 2001 From: UniquePassive Date: Sun, 22 Oct 2017 16:41:46 +0200 Subject: [PATCH 2/3] Fix checkstyle errors --- .../src/main/java/net/runelite/api/mixins/Copy.java | 12 ++++++------ .../main/java/net/runelite/api/mixins/Replace.java | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java b/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java index 7f5ee9cc22..c6afa7b7d4 100644 --- a/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java +++ b/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java @@ -33,10 +33,10 @@ import java.lang.annotation.Target; @Target(ElementType.METHOD) public @interface Copy { - /** - * Method to copy - * - * @return - */ - String value(); + /** + * Method to copy + * + * @return + */ + String value(); } diff --git a/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java b/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java index f24d5db0f3..e2f2444bed 100644 --- a/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java +++ b/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java @@ -33,10 +33,10 @@ import java.lang.annotation.Target; @Target(ElementType.METHOD) public @interface Replace { - /** - * Method to replace - * - * @return - */ - String value(); + /** + * Method to replace + * + * @return + */ + String value(); } From 367bd1e1ecafc37cb9208f4f6e231a8e2ea54a54 Mon Sep 17 00:00:00 2001 From: Adam Date: Sun, 22 Oct 2017 10:57:54 -0400 Subject: [PATCH 3/3] Add Documented annotation and javadoc to new mixin annotations --- .../src/main/java/net/runelite/api/mixins/Copy.java | 6 ++++++ .../src/main/java/net/runelite/api/mixins/Replace.java | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java b/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java index c6afa7b7d4..c4a3b46326 100644 --- a/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java +++ b/runelite-mixins/src/main/java/net/runelite/api/mixins/Copy.java @@ -24,13 +24,19 @@ */ package net.runelite.api.mixins; +import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * Indicates a copy of the specified method should be copied into + * the target class. + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) +@Documented public @interface Copy { /** diff --git a/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java b/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java index e2f2444bed..57f7edc0dc 100644 --- a/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java +++ b/runelite-mixins/src/main/java/net/runelite/api/mixins/Replace.java @@ -24,13 +24,18 @@ */ package net.runelite.api.mixins; +import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * Replaces the existing method in the target class with the given method. + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) +@Documented public @interface Replace { /**