Class Overview
Describes a commit to archive.
 
 In addition to specifying the commit to archive, callers can select from a standard set of
 archive formats. Any SCM which supports archiving repositories is required to
 support all of the standard formats.
 
 For finer control over the content of the archive, callers can also specify paths to filter
 by, and a prefix to prepend to the archive's contents. SCMs should support both of
 those settings if possible, but are not required to do so.
 
Summary
| Nested Classes | 
  
    
      | 
        
        
        
        
        class | 
      ArchiveCommandParameters.Builder | 
        | 
    
    
    
| 
  [Expand]
   Inherited Methods  | 
   
From class
  com.atlassian.bitbucket.util.BuilderSupport
  
   
  
    
    
	 
    
        | 
            
            
            
            
            static
            <T>
            boolean
         | 
        
        addIf(Predicate<? super T> predicate, Builder<T> builder, T value)
        
   |  
	 
    
        | 
            
            @SafeVarargs
            
            
            
            
            static
            <T>
            void
         | 
        
        addIf(Predicate<? super T> predicate, Builder<T> builder, T value, T... values)
        
   |  
	 
    
        | 
            
            
            
            
            static
            <T>
            boolean
         | 
        
        addIf(Predicate<? super T> predicate, Collection<T> collection, T value)
        
   |  
	 
    
        | 
            
            
            
            
            static
            <T>
            void
         | 
        
        addIf(Predicate<? super T> predicate, Builder<T> builder, Iterable<? extends T> values)
        
   |  
	 
    
        | 
            
            @SafeVarargs
            
            
            
            
            static
            <T>
            void
         | 
        
        addIf(Predicate<? super T> predicate, Collection<T> collection, T value, T... values)
        
   |  
	 
    
        | 
            
            
            
            
            static
            <T>
            void
         | 
        
        addIf(Predicate<? super T> predicate, Collection<T> collection, Iterable<? extends T> values)
        
   |  
	 
    
        | 
            
            @Nonnull
            
            
            
            
            static
            
            String
         | 
        
        checkNotBlank(String value, String name)
        
   |  
	 
    
        | 
            
            @Nonnull
            
            
            
            
            static
            
            String
         | 
        
        requireNonBlank(String value, String name)
        
   |  
 
   
 
 | 
   
From class
  java.lang.Object
  
   
  
    
    
	 
    
        | 
            
            
            
            
            
            
            Object
         | 
        
        clone()
        
   |  
	 
    
        | 
            
            
            
            
            
            
            boolean
         | 
        
        equals(Object arg0)
        
   |  
	 
    
        | 
            
            
            
            
            
            
            void
         | 
        
        finalize()
        
   |  
	 
    
        | 
            
            
            
            final
            
            
            Class<?>
         | 
        
        getClass()
        
   |  
	 
    
        | 
            
            
            
            
            
            
            int
         | 
        
        hashCode()
        
   |  
	 
    
        | 
            
            
            
            final
            
            
            void
         | 
        
        notify()
        
   |  
	 
    
        | 
            
            
            
            final
            
            
            void
         | 
        
        notifyAll()
        
   |  
	 
    
        | 
            
            
            
            
            
            
            String
         | 
        
        toString()
        
   |  
	 
    
        | 
            
            
            
            final
            
            
            void
         | 
        
        wait(long arg0, int arg1)
        
   |  
	 
    
        | 
            
            
            
            final
            
            
            void
         | 
        
        wait(long arg0)
        
   |  
	 
    
        | 
            
            
            
            final
            
            
            void
         | 
        
        wait()
        
   |  
 
   
 
 | 
Public Methods
    
      
        
        @Nonnull
        
        public
        
        
        
        
        String
      
      getCommitId
      ()
    
      
    
      
    
    
    
      
  
  
      Returns
      - the commit to archive, which may be a ref name or commit hash
 
   
     
 
    
      
        
        @Nonnull
        
        public
        
        
        
        
        ArchiveFormat
      
      getFormat
      ()
    
      
    
      
    
    
    
      
  
  
      Returns
      - the format to stream the archive in
 
   
     
 
    
      
        
        @Nonnull
        
        public
        
        
        
        
        Set<String>
      
      getPaths
      ()
    
      
    
      
    
    
    
      
  
  
      Returns
      - a set of paths to filter the archive by, which may be empty to include all paths
 
   
     
 
    
      
        
        @Nonnull
        
        public
        
        
        
        
        Optional<String>
      
      getPrefix
      ()
    
      
    
      
    
    
    
      
  
  
      Returns
      - a prefix to apply to all entries in the archive, which may be 
empty() but not null