001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.spi.connector.transport;
020
021import java.net.URI;
022import java.util.Map;
023
024/**
025 * A task to check the existence of a resource in the remote repository. <em>Note:</em> The listener returned from
026 * {@link #getListener()} is only used in the context of {@link TransportListener#transportPropertiesAvailable(Map)}.
027 *
028 * @see Transporter#peek(PeekTask)
029 */
030public final class PeekTask extends TransportTask {
031
032    /**
033     * Creates a new task for the specified remote resource.
034     *
035     * @param location The relative location of the resource in the remote repository, must not be {@code null}.
036     */
037    public PeekTask(URI location) {
038        setLocation(location);
039    }
040
041    @Override
042    public String toString() {
043        return "?? " + getLocation();
044    }
045
046    /**
047     * Sets the listener that is to be notified during the transfer.
048     *
049     * @param listener The listener to notify of progress, may be {@code null}.
050     * @return This task for chaining, never {@code null}.
051     */
052    public PeekTask setListener(TransportListener listener) {
053        super.setListener(listener);
054        return this;
055    }
056}