volume.go

package cluster

import "github.com/docker/engine-api/types"

// Volume is exported
type Volume struct {
	types.Volume

	Engine *Engine
}

// Volumes represents an array of volumes
type Volumes []*Volume

// Get returns a volume using its ID or Name
func (volumes Volumes) Get(name string) *Volume {
	// Abort immediately if the name is empty.
	if len(name) == 0 {
		return nil
	}

	candidates := []*Volume{}

	// Match name or engine/name.
	for _, volume := range volumes {
		if volume.Name == name || volume.Engine.ID+"/"+volume.Name == name || volume.Engine.Name+"/"+volume.Name == name {
			candidates = append(candidates, volume)
		}
	}

	// Return if we found a unique match.
	if size := len(candidates); size == 1 {
		return candidates[0]
	} else if size > 1 {
		// Match first volume with non-local driver
		for _, volume := range candidates {
			if volume.Name == name && volume.Driver != "local" {
				return volume
			}
		}
		return nil
	}

	// Match /name and return as soon as we find one.
	for _, volume := range volumes {
		if volume.Name == "/"+name {
			return volume
		}
	}

	return nil
}