src/main/java/net/pterodactylus/rhynodge/filters/ExtractUrlFilter.java

   1 /*
   2  * rhynodge - HttpQueryFilter.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.rhynodge.filters;
  19
  20 import static com.google.common.base.Preconditions.*;
  21
  22 import net.pterodactylus.rhynodge.Filter;
  23 import net.pterodactylus.rhynodge.State;
  24 import net.pterodactylus.rhynodge.states.FailedState;
  25 import net.pterodactylus.rhynodge.states.HtmlState;
  26 import net.pterodactylus.rhynodge.states.StringState;
  27
  28 import com.google.common.base.Optional;
  29 import org.jetbrains.annotations.NotNull;
  30 import org.jsoup.nodes.Document;
  31
  32 /**
  33  * {@link Filter} implementation that extracts a URL from an {@link HtmlState}.
  34  *
  35  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  36  */
  37 public abstract class ExtractUrlFilter implements Filter {
  38
  39         @NotNull
  40         @Override
  41         public State filter(@NotNull State state) {
  42                 checkArgument(state instanceof HtmlState, "state must be an HTML state");
  43
  44                 HtmlState htmlState = (HtmlState) state;
  45                 Optional<String> newUrl = extractUrl(htmlState.document());
  46
  47                 if (!newUrl.isPresent()) {
  48                         return new FailedState();
  49                 }
  50
  51                 return new StringState(newUrl.get());
  52         }
  53
  54         //
  55         // PROTECTED METHODS
  56         //
  57
  58         /**
  59          * Extracts the URL from the given document. If the returned value is {@link
  60          * Optional#absent()}, {@link #filter(State)} will return a {@link
  61          * FailedState}.
  62          *
  63          * @param document
  64          *              The document to extract the URL from
  65          * @return The extracted URL, or {@link Optional#absent()}
  66          */
  67         protected abstract Optional<String> extractUrl(Document document);
  68
  69 }