001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.swaps;
018
019import java.util.*;
020import java.util.regex.*;
021
022import org.apache.juneau.*;
023import org.apache.juneau.common.utils.*;
024import org.apache.juneau.swap.*;
025
026/**
027 * Transforms {@link MatchResult MatchResults} to {@code List} objects.
028 *
029 * <p>
030 * Entries in the list represent matched groups in a regular expression.
031 *
032 * <h5 class='section'>See Also:</h5><ul>
033 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/SwapBasics">Swap Basics</a>
034
035 * </ul>
036 */
037public class MatchResultSwap extends ObjectSwap<MatchResult,List<String>> {
038
039   /**
040    * Converts the specified {@link Enumeration} to a {@link List}.
041    */
042   @Override /* ObjectSwap */
043   public List<String> swap(BeanSession session, MatchResult o) {
044      List<String> l = Utils.listOfSize(o.groupCount());
045      for (int i = 0; i <= o.groupCount(); i++)
046         l.add(o.group(i));
047      return l;
048   }
049}